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 |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon')
726 files changed, 213645 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/Alias.html b/apidocs/com/amazon/carbonado/Alias.html new file mode 100644 index 0000000..863c963 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Alias.html @@ -0,0 +1,229 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Alias (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="Alias (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/Alias.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 Class</li> +<li><a href="../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Alias.html" target="_top">Frames</a></li> +<li><a href="Alias.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type Alias" class="title">Annotation Type Alias</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value={TYPE,METHOD}) +public @interface <span class="strong">Alias</span></pre> +<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. An alias is used + only by a repository to link to entities. Without an alias, the repository will perform + a best guess at finding an entity to use. Aliases may be ignored by repositories that + don't require explicitly named entities. + <P>The most common use for an alias is for a JDBC repository, to link a storable to a table and + its properties to the corresponding columns. Naming conventions for databases rarely work + well for class and variable names. + + <p>Example:<pre> + <b>@Alias("USER_INFO")</b> + @PrimaryKey("userInfoID") + public interface UserInfo extends Storable<UserInfo> { + <b>@Alias("USER_ID")</b> + long getUserInfoID(); + void setUserInfoID(long id); + + ... + } + </pre></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/Name.html" title="annotation in com.amazon.carbonado"><code>Name</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Alias.html#value()">value</a></strong></code> +<div class="block">Alias values for the storage layer to select from.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String[] value</pre> +<div class="block">Alias values for the storage layer to select from. It will choose the + first one in the list that matches one of its own entities.</div> +</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/Alias.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 Class</li> +<li><a href="../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Alias.html" target="_top">Frames</a></li> +<li><a href="Alias.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/AlternateKeys.html b/apidocs/com/amazon/carbonado/AlternateKeys.html new file mode 100644 index 0000000..a9a3ec6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/AlternateKeys.html @@ -0,0 +1,237 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AlternateKeys (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="AlternateKeys (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/AlternateKeys.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/Alias.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/AlternateKeys.html" target="_top">Frames</a></li> +<li><a href="AlternateKeys.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type AlternateKeys" class="title">Annotation Type AlternateKeys</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=TYPE) +public @interface <span class="strong">AlternateKeys</span></pre> +<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>. + + <p>Example:<pre> + <b>@AlternateKeys</b>({ + <b>@Key</b>("fullPath") + <b>@Key</b>({"+name", "-parentID"}) + }) + @PrimaryKey("ID") + public interface FileInfo extends Storable<FileInfo> { + long getID(); + void setID(long id); + + String getFullPath(); + void setFullPath(String path); + + String getName(); + void setName(String name); + + long getParentID(); + void setParentID(long id); + + ... + } + </pre></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/Key.html" title="annotation in com.amazon.carbonado"><code>Key</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">Key</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/AlternateKeys.html#value()">value</a></strong></code> +<div class="block">A list of Key annotations.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract <a href="../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">Key</a>[] value</pre> +<div class="block">A list of Key annotations.</div> +<dl> +<dt>Default:</dt> +<dd>{}</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/AlternateKeys.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/Alias.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/AlternateKeys.html" target="_top">Frames</a></li> +<li><a href="AlternateKeys.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/Authoritative.html b/apidocs/com/amazon/carbonado/Authoritative.html new file mode 100644 index 0000000..d0db0d0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Authoritative.html @@ -0,0 +1,183 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Authoritative (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="Authoritative (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/Authoritative.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/AlternateKeys.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Authoritative.html" target="_top">Frames</a></li> +<li><a href="Authoritative.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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</div> +<h2 title="Annotation Type Authoritative" class="title">Annotation Type Authoritative</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=TYPE) +public @interface <span class="strong">Authoritative</span></pre> +<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. When reading or writing the Storable, the <a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> must guarantee that it is operating on the latest, correct + version of the Storable. + + <p>Repositories that cache potentially stale Storables are required to + ensure the cache is always up-to-date or bypass the cache + altogether. Replicating repositories which may have a propagation delay must + always access the master repository. + + <p>Repositories which provide eventual consistency but don't rely on a + master <i>must</i> throw <a href="../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><code>UnsupportedTypeException</code></a>, as there is no + authoritative source. + + <p>Example:<pre> + <b>@Authoritative</b> + @PrimaryKey("sequenceName") + public interface SequenceValue extends Storable<SequenceValue> { + String getSequenceName(); + void setSequenceName(String name); + + long getNextValue(); + void setNextValue(long value); + + ... + } + </pre></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</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/Authoritative.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/AlternateKeys.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Authoritative.html" target="_top">Frames</a></li> +<li><a href="Authoritative.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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> diff --git a/apidocs/com/amazon/carbonado/Automatic.html b/apidocs/com/amazon/carbonado/Automatic.html new file mode 100644 index 0000000..6a57514 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Automatic.html @@ -0,0 +1,181 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Automatic (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="Automatic (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/Automatic.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/Authoritative.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Automatic.html" target="_top">Frames</a></li> +<li><a href="Automatic.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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</div> +<h2 title="Annotation Type Automatic" class="title">Annotation Type Automatic</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +public @interface <span class="strong">Automatic</span></pre> +<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. The actual process by which a value is automatically assigned is + repository dependent. In the JDBC repository, the value might come from an + auto-increment column or a database-specific trigger. + + <p>If the underlying repository doesn't automatically supply a value to an + automatic property, no immediate warning is given and instead the property + will be assigned a default value of null or zero. This may cause problems if + the automatic property is a member of a key. Explicitly specifying a value + can sometimes be used to bypass the automatic value altogether. + + <p>Example:<pre> + @PrimaryKey("userInfoID") + public interface UserInfo extends Storable<UserInfo> { + <b>@Automatic</b> + long getUserInfoID(); + void setUserInfoID(long id); + + ... + } + </pre></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a></dd></dl> +</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/Automatic.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/Authoritative.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Automatic.html" target="_top">Frames</a></li> +<li><a href="Automatic.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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> diff --git a/apidocs/com/amazon/carbonado/ConfigurationException.html b/apidocs/com/amazon/carbonado/ConfigurationException.html new file mode 100644 index 0000000..8ec2894 --- /dev/null +++ b/apidocs/com/amazon/carbonado/ConfigurationException.html @@ -0,0 +1,311 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ConfigurationException (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="ConfigurationException (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/ConfigurationException.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/Automatic.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/ConfigurationException.html" target="_top">Frames</a></li> +<li><a href="ConfigurationException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class ConfigurationException" class="title">Class ConfigurationException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.SupportException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.ConfigurationException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ConfigurationException</span> +extends <a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<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> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#com.amazon.carbonado.ConfigurationException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/ConfigurationException.html#ConfigurationException()">ConfigurationException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/ConfigurationException.html#ConfigurationException(java.lang.String)">ConfigurationException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/ConfigurationException.html#ConfigurationException(java.lang.String, java.lang.Throwable)">ConfigurationException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/ConfigurationException.html#ConfigurationException(java.lang.Throwable)">ConfigurationException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="ConfigurationException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConfigurationException</h4> +<pre>public ConfigurationException()</pre> +</li> +</ul> +<a name="ConfigurationException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConfigurationException</h4> +<pre>public ConfigurationException(java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="ConfigurationException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConfigurationException</h4> +<pre>public ConfigurationException(java.lang.String message)</pre> +</li> +</ul> +<a name="ConfigurationException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConfigurationException</h4> +<pre>public ConfigurationException(java.lang.String message, + java.lang.Throwable cause)</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/ConfigurationException.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/Automatic.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/ConfigurationException.html" target="_top">Frames</a></li> +<li><a href="ConfigurationException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/ConstraintException.html b/apidocs/com/amazon/carbonado/ConstraintException.html new file mode 100644 index 0000000..6ae6c0a --- /dev/null +++ b/apidocs/com/amazon/carbonado/ConstraintException.html @@ -0,0 +1,315 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ConstraintException (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="ConstraintException (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/ConstraintException.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/ConfigurationException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/ConstraintException.html" target="_top">Frames</a></li> +<li><a href="ConstraintException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class ConstraintException" class="title">Class ConstraintException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.ConstraintException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ConstraintException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.ConstraintException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/ConstraintException.html#ConstraintException()">ConstraintException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/ConstraintException.html#ConstraintException(java.lang.String)">ConstraintException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/ConstraintException.html#ConstraintException(java.lang.String, java.lang.Throwable)">ConstraintException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/ConstraintException.html#ConstraintException(java.lang.Throwable)">ConstraintException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="ConstraintException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConstraintException</h4> +<pre>public ConstraintException()</pre> +</li> +</ul> +<a name="ConstraintException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConstraintException</h4> +<pre>public ConstraintException(java.lang.String message)</pre> +</li> +</ul> +<a name="ConstraintException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConstraintException</h4> +<pre>public ConstraintException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="ConstraintException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConstraintException</h4> +<pre>public ConstraintException(java.lang.Throwable cause)</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/ConstraintException.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/ConfigurationException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/ConstraintException.html" target="_top">Frames</a></li> +<li><a href="ConstraintException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/CorruptEncodingException.html b/apidocs/com/amazon/carbonado/CorruptEncodingException.html new file mode 100644 index 0000000..8daef99 --- /dev/null +++ b/apidocs/com/amazon/carbonado/CorruptEncodingException.html @@ -0,0 +1,395 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>CorruptEncodingException (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="CorruptEncodingException (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/CorruptEncodingException.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/ConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/CorruptEncodingException.html" target="_top">Frames</a></li> +<li><a href="CorruptEncodingException.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><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</div> +<h2 title="Class CorruptEncodingException" class="title">Class CorruptEncodingException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.FetchException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.CorruptEncodingException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">CorruptEncodingException</span> +extends <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">A CorruptEncodingException is caused when decoding an encoded record fails.</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="../../../serialized-form.html#com.amazon.carbonado.CorruptEncodingException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/CorruptEncodingException.html#CorruptEncodingException()">CorruptEncodingException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException(int, int)">CorruptEncodingException</a></strong>(int expectedGeneration, + int actualGeneration)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException(java.lang.String)">CorruptEncodingException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException(java.lang.String, java.lang.Throwable)">CorruptEncodingException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException(java.lang.Throwable)">CorruptEncodingException</a></strong>(java.lang.Throwable cause)</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/CorruptEncodingException.html#getMessage()">getMessage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/CorruptEncodingException.html#getStorableWithPrimaryKey()">getStorableWithPrimaryKey</a></strong>()</code> +<div class="block">If the decoder was able to extract the primary key, it will be available in the + returned Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/CorruptEncodingException.html#setStorableWithPrimaryKey(com.amazon.carbonado.Storable)">setStorableWithPrimaryKey</a></strong>(<a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s)</code> +<div class="block">If the decoder can at least extract the primary key, it should set it here.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="CorruptEncodingException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CorruptEncodingException</h4> +<pre>public CorruptEncodingException()</pre> +</li> +</ul> +<a name="CorruptEncodingException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CorruptEncodingException</h4> +<pre>public CorruptEncodingException(java.lang.String message)</pre> +</li> +</ul> +<a name="CorruptEncodingException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CorruptEncodingException</h4> +<pre>public CorruptEncodingException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="CorruptEncodingException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CorruptEncodingException</h4> +<pre>public CorruptEncodingException(java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="CorruptEncodingException(int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CorruptEncodingException</h4> +<pre>public CorruptEncodingException(int expectedGeneration, + int actualGeneration)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedGeneration</code> - expected layout generation of decoded storable</dd><dd><code>actualGeneration</code> - actual layout generation of decoded storable</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="setStorableWithPrimaryKey(com.amazon.carbonado.Storable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStorableWithPrimaryKey</h4> +<pre>public void setStorableWithPrimaryKey(<a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s)</pre> +<div class="block">If the decoder can at least extract the primary key, it should set it here.</div> +</li> +</ul> +<a name="getStorableWithPrimaryKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableWithPrimaryKey</h4> +<pre>public <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> getStorableWithPrimaryKey()</pre> +<div class="block">If the decoder was able to extract the primary key, it will be available in the + returned Storable. If this exception was re-constructed through serialization, then + the Storable is as well. As a result, it won't be bound to any Repository and + updating it will have no effect.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>partial Storable with primary key defined, or null if unable to + decode the key</dd></dl> +</li> +</ul> +<a name="getMessage()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public java.lang.String getMessage()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>getMessage</code> in class <code>java.lang.Throwable</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/CorruptEncodingException.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/ConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/CorruptEncodingException.html" target="_top">Frames</a></li> +<li><a href="CorruptEncodingException.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><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> diff --git a/apidocs/com/amazon/carbonado/Cursor.html b/apidocs/com/amazon/carbonado/Cursor.html new file mode 100644 index 0000000..0230910 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Cursor.html @@ -0,0 +1,431 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Cursor (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="Cursor (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/Cursor.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/CorruptEncodingException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Cursor.html" target="_top">Frames</a></li> +<li><a href="Cursor.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</div> +<h2 title="Interface Cursor" class="title">Interface Cursor<S></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a>, <a href="../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a>, <a href="../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a>, <a href="../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a>, <a href="../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a>, <a href="../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a>, <a href="../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a>, <a href="../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a>, <a href="../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a>, <a href="../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a>, <a href="../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a>, <a href="../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a>, <a href="../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a>, <a href="../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a>, <a href="../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a>, <a href="../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a>, <a href="../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a>, <a href="../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a>, <a href="../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Cursor<S></span></pre> +<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. Cursors must be closed promptly when no longer + needed. Failure to do so may result in excessive resource consumption or + deadlock. As a convenience, the close operation is automatically performed + when the end is reached or when an exception is thrown. + + <P>Note: because a Cursor manages resources, it is inapproprate to create a long-lived one and + pass it around in your code. A cursor is expected to live close to the Query which vended + it. To discourage inappropriate retention, the cursor does not implement methods (like + "getQuery" or "reset") which would make it more convenient to operate on in isolation. + + <P>Similarly, it is difficult to guarantee that the results of a cursor will + be the same in case of a "reset" or reverse iteration. For this reason, + neither is supported; if you need to iterate the same set of objects twice, + simply retain the query object and reissue it. Be aware that the results may + not be identical, if any relevant objects are added to or removed the + repository in the interim. To guard against this, operate within a + serializable <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado"><code>isolation level</code></a>. + + <p>Cursor instances are mutable and not guaranteed to be thread-safe. Only + one thread should ever operate on a cursor instance.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Don Schneider</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/Cursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> c)</code> +<div class="block">Copies all remaining next elements into the given collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection, int)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> c, + int limit)</code> +<div class="block">Copies a limited amount of remaining next elements into the given + collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Cursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Cursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Cursor.html#toList()">toList</a></strong>()</code> +<div class="block">Copies all remaining next elements into a new modifiable list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Cursor.html#toList(int)">toList</a></strong>(int limit)</code> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list.</div> +</td> +</tr> +</table> +</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>void close() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>boolean hasNext() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a> next() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd> +<dd><code>java.util.NoSuchElementException</code> - if the cursor has no next element.</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>int skipNext(int amount) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if amount is negative</dd></dl> +</li> +</ul> +<a name="copyInto(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyInto</h4> +<pre>int copyInto(java.util.Collection<? super <a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> c) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Copies all remaining next elements into the given collection. This + method is roughly equivalent to the following: + <pre> + Cursor cursor; + ... + while (cursor.hasNext()) { + c.add(cursor.next()); + } + </pre> + + <p>As a side-effect of calling this method, the cursor is closed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>actual amount of results added</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="copyInto(java.util.Collection, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyInto</h4> +<pre>int copyInto(java.util.Collection<? super <a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> c, + int limit) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Copies a limited amount of remaining next elements into the given + collection. This method is roughly equivalent to the following: + <pre> + Cursor cursor; + ... + while (--limit >= 0 && cursor.hasNext()) { + c.add(cursor.next()); + } + </pre></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - maximum amount of elements to copy</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount of results added</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if limit is negative</dd></dl> +</li> +</ul> +<a name="toList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toList</h4> +<pre>java.util.List<<a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> toList() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Copies all remaining next elements into a new modifiable list. This + method is roughly equivalent to the following: + <pre> + Cursor<S> cursor; + ... + List<S> list = new ... + cursor.copyInto(list); + </pre> + + <p>As a side-effect of calling this method, the cursor is closed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a new modifiable list</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="toList(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toList</h4> +<pre>java.util.List<<a href="../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> toList(int limit) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list. This method is roughly equivalent to the following: + <pre> + Cursor<S> cursor; + ... + List<S> list = new ... + cursor.copyInto(list, limit); + </pre></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - maximum amount of elements to copy</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new modifiable list</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if limit is negative</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/Cursor.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/CorruptEncodingException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Cursor.html" target="_top">Frames</a></li> +<li><a href="Cursor.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> diff --git a/apidocs/com/amazon/carbonado/Derived.html b/apidocs/com/amazon/carbonado/Derived.html new file mode 100644 index 0000000..a27e556 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Derived.html @@ -0,0 +1,264 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Derived (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="Derived (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/Derived.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/Cursor.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Derived.html" target="_top">Frames</a></li> +<li><a href="Derived.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type Derived" class="title">Annotation Type Derived</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +public @interface <span class="strong">Derived</span></pre> +<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. A derived property cannot be + abstract, and a "set" method is optional. + + <p>Derived properties can be used just like a normal property in most + cases. They can be used in query filters, indexes, alternate keys, and they + can also be used to define a <a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>Version</code></a> property. + + <p>If the derived property depends on <a href="../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a> properties and is also + used in an index or alternate key, dependencies must be listed in order for + the index to be properly updated. + + <p>Example:<pre> + @Indexes(@Index("uppercaseName")) + public abstract class UserInfo implements Storable<UserInfo> { + /** + * Derive an uppercase name for case-insensitive searches. + */ + <b>@Derived</b> + public String getUppercaseName() { + String name = getName(); + return name == null ? null : name.toUpperCase(); + } + + ... + } + </pre></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Tobias Holgers</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Derived.html#from()">from</a></strong></code> +<div class="block">List of properties that this property is derived from.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Derived.html#shouldCopy()">shouldCopy</a></strong></code> +<div class="block">Returns whether this property should be included when copying a + storable.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="from()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>from</h4> +<pre>public abstract java.lang.String[] from</pre> +<div class="block">List of properties that this property is derived from.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="shouldCopy()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shouldCopy</h4> +<pre>public abstract boolean shouldCopy</pre> +<div class="block">Returns whether this property should be included when copying a + storable. Copying of a derived property uses the "get" and "set" methods + and requires the "set" method to be defined. Default false.</div> +<dl> +<dt>Default:</dt> +<dd>false</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/Derived.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/Cursor.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Derived.html" target="_top">Frames</a></li> +<li><a href="Derived.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/FetchDeadlockException.html b/apidocs/com/amazon/carbonado/FetchDeadlockException.html new file mode 100644 index 0000000..441911b --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchDeadlockException.html @@ -0,0 +1,349 @@ +<!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:39 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>FetchDeadlockException (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="FetchDeadlockException (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/FetchDeadlockException.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/Derived.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchDeadlockException.html" target="_top">Frames</a></li> +<li><a href="FetchDeadlockException.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><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</div> +<h2 title="Class FetchDeadlockException" class="title">Class FetchDeadlockException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.FetchException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.FetchDeadlockException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FetchDeadlockException</span> +extends <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Thrown if a fetch operation fails because it was selected to resolve a + deadlock.</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="../../../serialized-form.html#com.amazon.carbonado.FetchDeadlockException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/FetchDeadlockException.html#FetchDeadlockException()">FetchDeadlockException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchDeadlockException.html#FetchDeadlockException(java.lang.String)">FetchDeadlockException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchDeadlockException.html#FetchDeadlockException(java.lang.String, java.lang.Throwable)">FetchDeadlockException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchDeadlockException.html#FetchDeadlockException(java.lang.Throwable)">FetchDeadlockException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/FetchDeadlockException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="FetchDeadlockException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchDeadlockException</h4> +<pre>public FetchDeadlockException()</pre> +</li> +</ul> +<a name="FetchDeadlockException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchDeadlockException</h4> +<pre>public FetchDeadlockException(java.lang.String message)</pre> +</li> +</ul> +<a name="FetchDeadlockException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchDeadlockException</h4> +<pre>public FetchDeadlockException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="FetchDeadlockException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FetchDeadlockException</h4> +<pre>public FetchDeadlockException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makePersistException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makePersistException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> makePersistException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/FetchDeadlockException.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/Derived.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchDeadlockException.html" target="_top">Frames</a></li> +<li><a href="FetchDeadlockException.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><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> diff --git a/apidocs/com/amazon/carbonado/FetchException.html b/apidocs/com/amazon/carbonado/FetchException.html new file mode 100644 index 0000000..c1c872c --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchException.html @@ -0,0 +1,309 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>FetchException (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="FetchException (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/FetchException.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/FetchDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchException.html" target="_top">Frames</a></li> +<li><a href="FetchException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class FetchException" class="title">Class FetchException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.FetchException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a>, <a href="../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a>, <a href="../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a>, <a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a>, <a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a>, <a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FetchException</span> +extends <a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.FetchException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/FetchException.html#FetchException()">FetchException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchException.html#FetchException(java.lang.String)">FetchException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchException.html#FetchException(java.lang.String, java.lang.Throwable)">FetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchException.html#FetchException(java.lang.Throwable)">FetchException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="FetchException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchException</h4> +<pre>public FetchException()</pre> +</li> +</ul> +<a name="FetchException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchException</h4> +<pre>public FetchException(java.lang.String message)</pre> +</li> +</ul> +<a name="FetchException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchException</h4> +<pre>public FetchException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="FetchException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FetchException</h4> +<pre>public FetchException(java.lang.Throwable cause)</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/FetchException.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/FetchDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchException.html" target="_top">Frames</a></li> +<li><a href="FetchException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/FetchInterruptedException.html b/apidocs/com/amazon/carbonado/FetchInterruptedException.html new file mode 100644 index 0000000..f8a2069 --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchInterruptedException.html @@ -0,0 +1,348 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>FetchInterruptedException (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="FetchInterruptedException (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/FetchInterruptedException.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/FetchException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchInterruptedException.html" target="_top">Frames</a></li> +<li><a href="FetchInterruptedException.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><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</div> +<h2 title="Class FetchInterruptedException" class="title">Class FetchInterruptedException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.FetchException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.FetchInterruptedException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FetchInterruptedException</span> +extends <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Thrown from a fetch operation that was canceled.</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="../../../serialized-form.html#com.amazon.carbonado.FetchInterruptedException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/FetchInterruptedException.html#FetchInterruptedException()">FetchInterruptedException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchInterruptedException.html#FetchInterruptedException(java.lang.String)">FetchInterruptedException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchInterruptedException.html#FetchInterruptedException(java.lang.String, java.lang.Throwable)">FetchInterruptedException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchInterruptedException.html#FetchInterruptedException(java.lang.Throwable)">FetchInterruptedException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/FetchInterruptedException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="FetchInterruptedException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchInterruptedException</h4> +<pre>public FetchInterruptedException()</pre> +</li> +</ul> +<a name="FetchInterruptedException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchInterruptedException</h4> +<pre>public FetchInterruptedException(java.lang.String message)</pre> +</li> +</ul> +<a name="FetchInterruptedException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchInterruptedException</h4> +<pre>public FetchInterruptedException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="FetchInterruptedException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FetchInterruptedException</h4> +<pre>public FetchInterruptedException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makePersistException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makePersistException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> makePersistException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/FetchInterruptedException.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/FetchException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchInterruptedException.html" target="_top">Frames</a></li> +<li><a href="FetchInterruptedException.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><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> diff --git a/apidocs/com/amazon/carbonado/FetchMultipleException.html b/apidocs/com/amazon/carbonado/FetchMultipleException.html new file mode 100644 index 0000000..1958fd0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchMultipleException.html @@ -0,0 +1,349 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>FetchMultipleException (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="FetchMultipleException (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/FetchMultipleException.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/FetchInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchMultipleException.html" target="_top">Frames</a></li> +<li><a href="FetchMultipleException.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><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</div> +<h2 title="Class FetchMultipleException" class="title">Class FetchMultipleException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.FetchException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.FetchMultipleException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FetchMultipleException</span> +extends <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">A FetchMultipleException is thrown when a fetch operation returned more + than one record when at most one was expected.</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="../../../serialized-form.html#com.amazon.carbonado.FetchMultipleException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/FetchMultipleException.html#FetchMultipleException()">FetchMultipleException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchMultipleException.html#FetchMultipleException(java.lang.String)">FetchMultipleException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchMultipleException.html#FetchMultipleException(java.lang.String, java.lang.Throwable)">FetchMultipleException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchMultipleException.html#FetchMultipleException(java.lang.Throwable)">FetchMultipleException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/FetchMultipleException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="FetchMultipleException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchMultipleException</h4> +<pre>public FetchMultipleException()</pre> +</li> +</ul> +<a name="FetchMultipleException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchMultipleException</h4> +<pre>public FetchMultipleException(java.lang.String message)</pre> +</li> +</ul> +<a name="FetchMultipleException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchMultipleException</h4> +<pre>public FetchMultipleException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="FetchMultipleException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FetchMultipleException</h4> +<pre>public FetchMultipleException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makePersistException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makePersistException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> makePersistException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/FetchMultipleException.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/FetchInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchMultipleException.html" target="_top">Frames</a></li> +<li><a href="FetchMultipleException.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><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> diff --git a/apidocs/com/amazon/carbonado/FetchNoneException.html b/apidocs/com/amazon/carbonado/FetchNoneException.html new file mode 100644 index 0000000..fccff8b --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchNoneException.html @@ -0,0 +1,349 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>FetchNoneException (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="FetchNoneException (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/FetchNoneException.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/FetchMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchNoneException.html" target="_top">Frames</a></li> +<li><a href="FetchNoneException.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><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</div> +<h2 title="Class FetchNoneException" class="title">Class FetchNoneException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.FetchException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.FetchNoneException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FetchNoneException</span> +extends <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">A FetchNoneException is thrown when a fetch operation returned no records + when at least one was expected.</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="../../../serialized-form.html#com.amazon.carbonado.FetchNoneException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/FetchNoneException.html#FetchNoneException()">FetchNoneException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchNoneException.html#FetchNoneException(java.lang.String)">FetchNoneException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchNoneException.html#FetchNoneException(java.lang.String, java.lang.Throwable)">FetchNoneException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchNoneException.html#FetchNoneException(java.lang.Throwable)">FetchNoneException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/FetchNoneException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="FetchNoneException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchNoneException</h4> +<pre>public FetchNoneException()</pre> +</li> +</ul> +<a name="FetchNoneException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchNoneException</h4> +<pre>public FetchNoneException(java.lang.String message)</pre> +</li> +</ul> +<a name="FetchNoneException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchNoneException</h4> +<pre>public FetchNoneException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="FetchNoneException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FetchNoneException</h4> +<pre>public FetchNoneException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makePersistException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makePersistException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> makePersistException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/FetchNoneException.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/FetchMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchNoneException.html" target="_top">Frames</a></li> +<li><a href="FetchNoneException.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><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> diff --git a/apidocs/com/amazon/carbonado/FetchTimeoutException.html b/apidocs/com/amazon/carbonado/FetchTimeoutException.html new file mode 100644 index 0000000..3d4bfe0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/FetchTimeoutException.html @@ -0,0 +1,348 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>FetchTimeoutException (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="FetchTimeoutException (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/FetchTimeoutException.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/FetchNoneException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchTimeoutException.html" target="_top">Frames</a></li> +<li><a href="FetchTimeoutException.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><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</div> +<h2 title="Class FetchTimeoutException" class="title">Class FetchTimeoutException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.FetchException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.FetchTimeoutException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FetchTimeoutException</span> +extends <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Thrown if a fetch operation fails because lock acquisition timed out.</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="../../../serialized-form.html#com.amazon.carbonado.FetchTimeoutException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/FetchTimeoutException.html#FetchTimeoutException()">FetchTimeoutException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchTimeoutException.html#FetchTimeoutException(java.lang.String)">FetchTimeoutException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchTimeoutException.html#FetchTimeoutException(java.lang.String, java.lang.Throwable)">FetchTimeoutException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/FetchTimeoutException.html#FetchTimeoutException(java.lang.Throwable)">FetchTimeoutException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/FetchTimeoutException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="FetchTimeoutException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchTimeoutException</h4> +<pre>public FetchTimeoutException()</pre> +</li> +</ul> +<a name="FetchTimeoutException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchTimeoutException</h4> +<pre>public FetchTimeoutException(java.lang.String message)</pre> +</li> +</ul> +<a name="FetchTimeoutException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FetchTimeoutException</h4> +<pre>public FetchTimeoutException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="FetchTimeoutException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FetchTimeoutException</h4> +<pre>public FetchTimeoutException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makePersistException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makePersistException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> makePersistException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/FetchTimeoutException.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/FetchNoneException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/FetchTimeoutException.html" target="_top">Frames</a></li> +<li><a href="FetchTimeoutException.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><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> diff --git a/apidocs/com/amazon/carbonado/Independent.html b/apidocs/com/amazon/carbonado/Independent.html new file mode 100644 index 0000000..439e0c2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Independent.html @@ -0,0 +1,193 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Independent (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="Independent (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/Independent.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/FetchTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Independent.html" target="_top">Frames</a></li> +<li><a href="Independent.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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</div> +<h2 title="Annotation Type Independent" class="title">Annotation Type Independent</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value={TYPE,METHOD}) +public @interface <span class="strong">Independent</span></pre> +<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. Ordinarily, if a dependent repository cannot + find a matching property, it throws <a href="../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado"><code>MismatchException</code></a> when the <a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a> is + first retrieved for the storable. This annotation suppresses that exception, and instead + makes the property or type unsupported. Any subsequent invocation of a property access + method for the independent type or property will cause an UnsupportedOperationException + to be thrown. + + <p>One example of when this might be used would be to store a calculated + field in the cached representation of the object. It is <b>not</b> + necessary to prevent implemented methods of the form "get<value>" + from being inadvertently interpreted as properties of the storable; any + implementation is by definition not a property. + + <p>If a correctly matching property actually is found, then this annotation + is ignored and the property or type is defined as usual. If the Repository + finds a property whose name matches, but whose type does not match, a + MismatchException will be thrown regardless of this annotation. + + <p>Independent repositories completely ignore this annotation. + + <p>Example:<pre> + public interface UserInfo extends Storable<UserInfo> { + <b>@Independent</b> + String getName(); + void setName(String name); + + ... + } + </pre> + + <b>Note:</b> If a <a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>versioned</code></a> Storable with an independent + property is managed by a replicating repository, updates which modify just + the independent property still update the master Storable, in order to get a + new record version. Therefore, independent properties should not be used as + a performance enhancement which avoids writes to a master repository.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</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/Independent.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/FetchTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Independent.html" target="_top">Frames</a></li> +<li><a href="Independent.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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> diff --git a/apidocs/com/amazon/carbonado/Index.html b/apidocs/com/amazon/carbonado/Index.html new file mode 100644 index 0000000..e921a0a --- /dev/null +++ b/apidocs/com/amazon/carbonado/Index.html @@ -0,0 +1,213 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Index (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="Index (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/Index.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/Independent.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Index.html" target="_top">Frames</a></li> +<li><a href="Index.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type Index" class="title">Annotation Type Index</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value={}) +public @interface <span class="strong">Index</span></pre> +<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. Indexes are contained by an + <a href="../../../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado"><code>Indexes</code></a> annotation.</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/Indexes.html" title="annotation in com.amazon.carbonado"><code>Indexes</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Index.html#value()">value</a></strong></code> +<div class="block">A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String[] value</pre> +<div class="block">A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.</div> +</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/Index.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/Independent.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Index.html" target="_top">Frames</a></li> +<li><a href="Index.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/Indexes.html b/apidocs/com/amazon/carbonado/Indexes.html new file mode 100644 index 0000000..c70fbda --- /dev/null +++ b/apidocs/com/amazon/carbonado/Indexes.html @@ -0,0 +1,239 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Indexes (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="Indexes (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/Indexes.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/Index.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Indexes.html" target="_top">Frames</a></li> +<li><a href="Indexes.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type Indexes" class="title">Annotation Type Indexes</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=TYPE) +public @interface <span class="strong">Indexes</span></pre> +<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. + + <p>Example:<pre> + <b>@Indexes</b>({ + <b>@Index</b>("name"), + <b>@Index</b>("-lastModified"), + <b>@Index</b>({"length", "lastModified"}) + }) + @PrimaryKey("ID") + public interface FileInfo extends Storable<FileInfo> { + long getID(); + void setID(long id); + + String getName(); + void setName(String name); + + long getLength(); + void setLength(long length); + + long getLastModified(); + void getLastModified(long datetime); + + ... + } + </pre></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/Index.html" title="annotation in com.amazon.carbonado"><code>Index</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado">Index</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Indexes.html#value()">value</a></strong></code> +<div class="block">A list of Index annotations.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract <a href="../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado">Index</a>[] value</pre> +<div class="block">A list of Index annotations.</div> +<dl> +<dt>Default:</dt> +<dd>{}</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/Indexes.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/Index.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Indexes.html" target="_top">Frames</a></li> +<li><a href="Indexes.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/IsolationLevel.html b/apidocs/com/amazon/carbonado/IsolationLevel.html new file mode 100644 index 0000000..e79cf52 --- /dev/null +++ b/apidocs/com/amazon/carbonado/IsolationLevel.html @@ -0,0 +1,510 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IsolationLevel (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="IsolationLevel (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/IsolationLevel.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/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/IsolationLevel.html" target="_top">Frames</a></li> +<li><a href="IsolationLevel.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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</div> +<h2 title="Enum IsolationLevel" class="title">Enum IsolationLevel</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.IsolationLevel</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">IsolationLevel</span> +extends java.lang.Enum<<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>></pre> +<div class="block">Describes a transaction isolation level. Transaction levels, in order from + lowest to highest are: + + <ul> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#READ_UNCOMMITTED"><code>READ_UNCOMMITTED</code></a> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#READ_COMMITTED"><code>READ_COMMITTED</code></a> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#REPEATABLE_READ"><code>REPEATABLE_READ</code></a> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#SNAPSHOT"><code>SNAPSHOT</code></a> + <li><a href="../../../com/amazon/carbonado/IsolationLevel.html#SERIALIZABLE"><code>SERIALIZABLE</code></a> + </ul> + + A transaction's isolation level is usually <code>READ_COMMITTED</code> or + <code>REPEATABLE_READ</code> by default. Forcing a lower level, like + <code>READ_COMMITTED</code>, is useful when performing a long cursor + iteration. It releases locks during iteration rather than holding on to them + until the transaction exits. + + <p><code>SNAPSHOT</code> isolation is special in that it uses multiversion + concurrency control (MVCC). A commit may fail with an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a>. Few repositories are expected to support this + level, however.</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/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>, +<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><code>Transaction</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#NONE">NONE</a></strong></code> +<div class="block">Indicates that no actual transaction is in progress.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#READ_COMMITTED">READ_COMMITTED</a></strong></code> +<div class="block">Indicates that dirty reads are prevented.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#READ_UNCOMMITTED">READ_UNCOMMITTED</a></strong></code> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads can + occur.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#REPEATABLE_READ">REPEATABLE_READ</a></strong></code> +<div class="block">Indicates that dirty reads and non-repeatable reads are prevented.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#SERIALIZABLE">SERIALIZABLE</a></strong></code> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#SNAPSHOT">SNAPSHOT</a></strong></code> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented.</div> +</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/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#highestCommon(com.amazon.carbonado.IsolationLevel)">highestCommon</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns the highest common isolation level between this and the one + given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#isAtLeast(com.amazon.carbonado.IsolationLevel)">isAtLeast</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns true if this isolation level is at least as high as the one + given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#isAtMost(com.amazon.carbonado.IsolationLevel)">isAtMost</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns true if this isolation level is no higher than the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#lowestCommon(com.amazon.carbonado.IsolationLevel)">lowestCommon</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns the lowest common isolation level between this and the one + given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/IsolationLevel.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="NONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NONE</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> NONE</pre> +<div class="block">Indicates that no actual transaction is in progress. If this level is + specified when entering a transaction, it uses auto-commit mode.</div> +</li> +</ul> +<a name="READ_UNCOMMITTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>READ_UNCOMMITTED</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> READ_UNCOMMITTED</pre> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads can + occur. This level allows modifications by one transaction to be read by + another transaction before any changes have been committed (a "dirty + read"). If any of the changes are rolled back, the second transaction + will have retrieved an invalid modification. + + <p>This level is also known as degree 1 isolation.</div> +</li> +</ul> +<a name="READ_COMMITTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>READ_COMMITTED</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> READ_COMMITTED</pre> +<div class="block">Indicates that dirty reads are prevented. Non-repeatable reads and + phantom reads can occur. This level only prohibits a transaction from + reading modifications with uncommitted changes in it. + + <p>This level is also known as degree 2 isolation.</div> +</li> +</ul> +<a name="REPEATABLE_READ"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REPEATABLE_READ</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> REPEATABLE_READ</pre> +<div class="block">Indicates that dirty reads and non-repeatable reads are prevented. + Phantom reads can occur. This level prohibits a transaction from reading + uncommitted changes, and it also prohibits the situation where one + transaction reads a record, a second transaction alters the record, and + the first transaction rereads the record, getting different values the + second time (a "non-repeatable read").</div> +</li> +</ul> +<a name="SNAPSHOT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SNAPSHOT</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> SNAPSHOT</pre> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented. Commits can still fail however, as snapshot isolation avoids + using locks.</div> +</li> +</ul> +<a name="SERIALIZABLE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SERIALIZABLE</h4> +<pre>public static final <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> SERIALIZABLE</pre> +<div class="block">Indicates that dirty reads, non-repeatable reads and phantom reads are + prevented. Phantoms are records returned as a result of a search, but + which were not seen by the same transaction when the identical search + criteria was previously used. For example, another transaction may have + inserted records which match the original search. + + <p>This level is also known as degree 3 isolation.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (IsolationLevel c : IsolationLevel.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="isAtLeast(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAtLeast</h4> +<pre>public boolean isAtLeast(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns true if this isolation level is at least as high as the one + given.</div> +</li> +</ul> +<a name="isAtMost(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAtMost</h4> +<pre>public boolean isAtMost(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns true if this isolation level is no higher than the one given.</div> +</li> +</ul> +<a name="lowestCommon(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lowestCommon</h4> +<pre>public <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> lowestCommon(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns the lowest common isolation level between this and the one + given.</div> +</li> +</ul> +<a name="highestCommon(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>highestCommon</h4> +<pre>public <a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> highestCommon(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns the highest common isolation level between this and the one + given.</div> +</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/IsolationLevel.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/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/IsolationLevel.html" target="_top">Frames</a></li> +<li><a href="IsolationLevel.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/Join.html b/apidocs/com/amazon/carbonado/Join.html new file mode 100644 index 0000000..3a5394b --- /dev/null +++ b/apidocs/com/amazon/carbonado/Join.html @@ -0,0 +1,314 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Join (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="Join (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/Join.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/IsolationLevel.html" title="enum in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Join.html" target="_top">Frames</a></li> +<li><a href="Join.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type Join" class="title">Annotation Type Join</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +public @interface <span class="strong">Join</span></pre> +<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. Joins can also refer to their own enclosing + class or interface. + <p> + To complete the join, lists of internal and external properties may be + supplied. If these lists are not supplied, then join is "natural", and the + properties are determined automatically. When the lists are specified, the + join is "explicit". Natural joins are merely a convenience; they can always + be replaced by an explicit join. + <p> + The lists used for explicit joins must have the same length, and each must + have at least one element. Each element in the internal list must refer to + a property defined in this property's class or interface, and each element + in the external list must refer to a matching property defined in the joined + type. The matched up property pairs must not themselves be join properties, + and they must be compatible with each other. + <p> + If the join is made to external properties which do not completely specify a + primary key, then the type of the join property must be a <a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> of + the joined type. When the type is a Query, a property mutator method cannot + be defined. The returned query has all of the "with" parameters filled in. + <p> + With a natural join, the internal and external properties are deduced by + examining the type of the referenced join property. If the type is a Query, + then the internal and external properties are set to match this property's + primary key. The referenced join property (specified as a parameterized type + to Query) must have properties matching name and type of this property's + primary key. + <p> + If a natural join's property type is not defined by a Query, then the + internal and external properties are set to match the referenced property's + primary key. This join property must have properties matching name and type + of the referenced property's primary key. + + <p>Example:<pre> + @PrimaryKey("addressID") + public interface Address extends Storable { + int getAddressID(); + + ... + } + + @PrimaryKey("userID") + public interface UserInfo extends Storable { + int getUserID(); + void setUserID(int id); + + int getAddressID(); + void setAddressID(int value); + + // Natural join, which works because Address has a primary key + // property of addressID which matches a property in this type. + <b>@Join</b> + Address getAddress() throws FetchException; + void setAddress(Address address); + + // Explicit join, equivalent to getAddress. + <b>@Join(internal="addressID", external="addressID")</b> + Address getCurrentAddress() throws FetchException; + void setCurrentAddress(Address address); + + @Nullable + Integer getParentID(); + void setParentID(Integer value); + + // Many-to-one relationship + @Nullable + <b>@Join(internal="parentID", external="userID")</b> + UserInfo getParent() throws FetchException; + void setParent(UserInfo parent); + + // One-to-many relationship + <b>@Join(internal="userID", external="parentID")</b> + Query<UserInfo> getChildren() throws FetchException; + + ... + } + </pre></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"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Join.html#external()">external</a></strong></code> +<div class="block">List of property names defined in the foreign property's enclosing class + or interface.</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/Join.html#internal()">internal</a></strong></code> +<div class="block">List of property names defined in this property's enclosing class or + interface.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="internal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>internal</h4> +<pre>public abstract java.lang.String[] internal</pre> +<div class="block">List of property names defined in this property's enclosing class or + interface.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="external()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>external</h4> +<pre>public abstract java.lang.String[] external</pre> +<div class="block">List of property names defined in the foreign property's enclosing class + or interface.</div> +<dl> +<dt>Default:</dt> +<dd>{}</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/Join.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/IsolationLevel.html" title="enum in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Join.html" target="_top">Frames</a></li> +<li><a href="Join.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/Key.html b/apidocs/com/amazon/carbonado/Key.html new file mode 100644 index 0000000..3ee0b17 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Key.html @@ -0,0 +1,217 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Key (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="Key (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/Key.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/Join.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Key.html" target="_top">Frames</a></li> +<li><a href="Key.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type Key" class="title">Annotation Type Key</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value={}) +public @interface <span class="strong">Key</span></pre> +<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. An alternate key is just as good as the primary key for uniquely + identifying a storable instance, except repositories are usually more + flexible with alternate keys. For example, dropping an alternate key and + reconstructing it should not result in loss of data. Alternate keys are + often implemented as indexes with a uniqueness constraint.</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/AlternateKeys.html" title="annotation in com.amazon.carbonado"><code>AlternateKeys</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Key.html#value()">value</a></strong></code> +<div class="block">A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String[] value</pre> +<div class="block">A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.</div> +</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/Key.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/Join.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Key.html" target="_top">Frames</a></li> +<li><a href="Key.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/MalformedArgumentException.html b/apidocs/com/amazon/carbonado/MalformedArgumentException.html new file mode 100644 index 0000000..27c1444 --- /dev/null +++ b/apidocs/com/amazon/carbonado/MalformedArgumentException.html @@ -0,0 +1,349 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>MalformedArgumentException (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="MalformedArgumentException (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/MalformedArgumentException.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/Key.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/MalformedArgumentException.html" target="_top">Frames</a></li> +<li><a href="MalformedArgumentException.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><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</div> +<h2 title="Class MalformedArgumentException" class="title">Class MalformedArgumentException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li>java.lang.IllegalArgumentException</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.MalformedArgumentException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a>, <a href="../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">MalformedArgumentException</span> +extends java.lang.IllegalArgumentException</pre> +<div class="block">A MalformedArgumentException is thrown after detailed analysis on an + argument determined it was not suitable. This class is abstract to prevent + its direct use. Subclasses are encouraged to provide more detail as to the + cause of the exception.</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="../../../serialized-form.html#com.amazon.carbonado.MalformedArgumentException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MalformedArgumentException.html#MalformedArgumentException()">MalformedArgumentException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MalformedArgumentException.html#MalformedArgumentException(java.util.List)">MalformedArgumentException</a></strong>(java.util.List<java.lang.String> messages)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MalformedArgumentException.html#MalformedArgumentException(java.lang.String)">MalformedArgumentException</a></strong>(java.lang.String message)</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MalformedArgumentException.html#getMessage()">getMessage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MalformedArgumentException.html#getMessages()">getMessages</a></strong>()</code> +<div class="block">Multiple error messages may be embedded in a MalformedArgumentException.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="MalformedArgumentException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MalformedArgumentException</h4> +<pre>protected MalformedArgumentException()</pre> +</li> +</ul> +<a name="MalformedArgumentException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MalformedArgumentException</h4> +<pre>protected MalformedArgumentException(java.lang.String message)</pre> +</li> +</ul> +<a name="MalformedArgumentException(java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MalformedArgumentException</h4> +<pre>protected MalformedArgumentException(java.util.List<java.lang.String> messages)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getMessage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public java.lang.String getMessage()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>getMessage</code> in class <code>java.lang.Throwable</code></dd> +</dl> +</li> +</ul> +<a name="getMessages()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMessages</h4> +<pre>public java.util.List<java.lang.String> getMessages()</pre> +<div class="block">Multiple error messages may be embedded in a MalformedArgumentException.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>non-null, unmodifiable list of messages</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/MalformedArgumentException.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/Key.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/MalformedArgumentException.html" target="_top">Frames</a></li> +<li><a href="MalformedArgumentException.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><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> diff --git a/apidocs/com/amazon/carbonado/MalformedFilterException.html b/apidocs/com/amazon/carbonado/MalformedFilterException.html new file mode 100644 index 0000000..e5e7815 --- /dev/null +++ b/apidocs/com/amazon/carbonado/MalformedFilterException.html @@ -0,0 +1,371 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>MalformedFilterException (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="MalformedFilterException (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/MalformedFilterException.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/MalformedArgumentException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/MalformedFilterException.html" target="_top">Frames</a></li> +<li><a href="MalformedFilterException.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><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</div> +<h2 title="Class MalformedFilterException" class="title">Class MalformedFilterException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li>java.lang.IllegalArgumentException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.MalformedArgumentException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.MalformedFilterException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MalformedFilterException</span> +extends <a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.MalformedFilterException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/MalformedFilterException.html#MalformedFilterException(java.lang.String)">MalformedFilterException</a></strong>(java.lang.String filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MalformedFilterException.html#MalformedFilterException(java.lang.String, int)">MalformedFilterException</a></strong>(java.lang.String filter, + int index)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MalformedFilterException.html#MalformedFilterException(java.lang.String, java.lang.String)">MalformedFilterException</a></strong>(java.lang.String filter, + java.lang.String message)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MalformedFilterException.html#MalformedFilterException(java.lang.String, java.lang.String, int)">MalformedFilterException</a></strong>(java.lang.String filter, + java.lang.String message, + int index)</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MalformedFilterException.html#getCulpritIndex()">getCulpritIndex</a></strong>()</code> +<div class="block">Returns the index into the query filter string that is malformed, or a + negative value if not known.</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/MalformedFilterException.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the malformed query filter.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.MalformedArgumentException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></h3> +<code><a href="../../../com/amazon/carbonado/MalformedArgumentException.html#getMessage()">getMessage</a>, <a href="../../../com/amazon/carbonado/MalformedArgumentException.html#getMessages()">getMessages</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="MalformedFilterException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MalformedFilterException</h4> +<pre>public MalformedFilterException(java.lang.String filter)</pre> +</li> +</ul> +<a name="MalformedFilterException(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MalformedFilterException</h4> +<pre>public MalformedFilterException(java.lang.String filter, + int index)</pre> +</li> +</ul> +<a name="MalformedFilterException(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MalformedFilterException</h4> +<pre>public MalformedFilterException(java.lang.String filter, + java.lang.String message)</pre> +</li> +</ul> +<a name="MalformedFilterException(java.lang.String, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MalformedFilterException</h4> +<pre>public MalformedFilterException(java.lang.String filter, + java.lang.String message, + int index)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public java.lang.String getFilter()</pre> +<div class="block">Returns the malformed query filter.</div> +</li> +</ul> +<a name="getCulpritIndex()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCulpritIndex</h4> +<pre>public int getCulpritIndex()</pre> +<div class="block">Returns the index into the query filter string that is malformed, or a + negative value if not known.</div> +</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/MalformedFilterException.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/MalformedArgumentException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/MalformedFilterException.html" target="_top">Frames</a></li> +<li><a href="MalformedFilterException.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><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> diff --git a/apidocs/com/amazon/carbonado/MalformedTypeException.html b/apidocs/com/amazon/carbonado/MalformedTypeException.html new file mode 100644 index 0000000..9181e2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/MalformedTypeException.html @@ -0,0 +1,354 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>MalformedTypeException (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="MalformedTypeException (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/MalformedTypeException.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/MalformedFilterException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/MalformedTypeException.html" target="_top">Frames</a></li> +<li><a href="MalformedTypeException.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><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</div> +<h2 title="Class MalformedTypeException" class="title">Class MalformedTypeException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li>java.lang.IllegalArgumentException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.MalformedArgumentException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.MalformedTypeException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MalformedTypeException</span> +extends <a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.MalformedTypeException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/MalformedTypeException.html#MalformedTypeException(java.lang.Class)">MalformedTypeException</a></strong>(java.lang.Class<?> malformedType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MalformedTypeException.html#MalformedTypeException(java.lang.Class, java.util.List)">MalformedTypeException</a></strong>(java.lang.Class<?> malformedType, + java.util.List<java.lang.String> messages)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MalformedTypeException.html#MalformedTypeException(java.lang.Class, java.lang.String)">MalformedTypeException</a></strong>(java.lang.Class<?> malformedType, + java.lang.String message)</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>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MalformedTypeException.html#getMalformedType()">getMalformedType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MalformedTypeException.html#getMessage()">getMessage</a></strong>()</code> +<div class="block">Returns first message, prefixed with the malformed type.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.MalformedArgumentException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></h3> +<code><a href="../../../com/amazon/carbonado/MalformedArgumentException.html#getMessages()">getMessages</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="MalformedTypeException(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MalformedTypeException</h4> +<pre>public MalformedTypeException(java.lang.Class<?> malformedType)</pre> +</li> +</ul> +<a name="MalformedTypeException(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MalformedTypeException</h4> +<pre>public MalformedTypeException(java.lang.Class<?> malformedType, + java.lang.String message)</pre> +</li> +</ul> +<a name="MalformedTypeException(java.lang.Class, java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MalformedTypeException</h4> +<pre>public MalformedTypeException(java.lang.Class<?> malformedType, + java.util.List<java.lang.String> messages)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getMessage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public java.lang.String getMessage()</pre> +<div class="block">Returns first message, prefixed with the malformed type.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/MalformedArgumentException.html#getMessage()">getMessage</a></code> in class <code><a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></code></dd> +</dl> +</li> +</ul> +<a name="getMalformedType()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMalformedType</h4> +<pre>public java.lang.Class<?> getMalformedType()</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/MalformedTypeException.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/MalformedFilterException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/MalformedTypeException.html" target="_top">Frames</a></li> +<li><a href="MalformedTypeException.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><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> diff --git a/apidocs/com/amazon/carbonado/MismatchException.html b/apidocs/com/amazon/carbonado/MismatchException.html new file mode 100644 index 0000000..8310273 --- /dev/null +++ b/apidocs/com/amazon/carbonado/MismatchException.html @@ -0,0 +1,393 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>MismatchException (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="MismatchException (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/MismatchException.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/MalformedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/MismatchException.html" target="_top">Frames</a></li> +<li><a href="MismatchException.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><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</div> +<h2 title="Class MismatchException" class="title">Class MismatchException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.SupportException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.MismatchException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MismatchException</span> +extends <a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<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. This exception may only be thrown by repositories with a dependency + on an external schema.</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="../../../serialized-form.html#com.amazon.carbonado.MismatchException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/MismatchException.html#MismatchException()">MismatchException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MismatchException.html#MismatchException(java.lang.Class)">MismatchException</a></strong>(java.lang.Class<?> malformedType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MismatchException.html#MismatchException(java.lang.Class, java.util.List)">MismatchException</a></strong>(java.lang.Class<?> malformedType, + java.util.List<java.lang.String> messages)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MismatchException.html#MismatchException(java.lang.Class, java.lang.String)">MismatchException</a></strong>(java.lang.Class<?> malformedType, + java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MismatchException.html#MismatchException(java.util.List)">MismatchException</a></strong>(java.util.List<java.lang.String> messages)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/MismatchException.html#MismatchException(java.lang.String)">MismatchException</a></strong>(java.lang.String message)</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MismatchException.html#getMessage()">getMessage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/MismatchException.html#getMessages()">getMessages</a></strong>()</code> +<div class="block">Multiple error messages may be embedded in a MismatchException.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="MismatchException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MismatchException</h4> +<pre>public MismatchException()</pre> +</li> +</ul> +<a name="MismatchException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MismatchException</h4> +<pre>public MismatchException(java.lang.String message)</pre> +</li> +</ul> +<a name="MismatchException(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MismatchException</h4> +<pre>public MismatchException(java.util.List<java.lang.String> messages)</pre> +</li> +</ul> +<a name="MismatchException(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MismatchException</h4> +<pre>public MismatchException(java.lang.Class<?> malformedType)</pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="MismatchException(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MismatchException</h4> +<pre>public MismatchException(java.lang.Class<?> malformedType, + java.lang.String message)</pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="MismatchException(java.lang.Class, java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MismatchException</h4> +<pre>public MismatchException(java.lang.Class<?> malformedType, + java.util.List<java.lang.String> messages)</pre> +<dl><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="getMessage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public java.lang.String getMessage()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>getMessage</code> in class <code>java.lang.Throwable</code></dd> +</dl> +</li> +</ul> +<a name="getMessages()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMessages</h4> +<pre>public java.util.List<java.lang.String> getMessages()</pre> +<div class="block">Multiple error messages may be embedded in a MismatchException.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>non-null, unmodifiable list of messages</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/MismatchException.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/MalformedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/MismatchException.html" target="_top">Frames</a></li> +<li><a href="MismatchException.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><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> diff --git a/apidocs/com/amazon/carbonado/Name.html b/apidocs/com/amazon/carbonado/Name.html new file mode 100644 index 0000000..496a561 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Name.html @@ -0,0 +1,228 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Name (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="Name (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/Name.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/MismatchException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Name.html" target="_top">Frames</a></li> +<li><a href="Name.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type Name" class="title">Annotation Type Name</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +public @interface <span class="strong">Name</span></pre> +<div class="block">Overrides the primary name of a Storable property. By default, the primary + name of a property is determined by JavaBeans conventions. When overridden, + all references to the named property must use the new name. + + <p>Example:<pre> + @PrimaryKey(<b>"userId"</b>) + public interface UserInfo extends Storable<UserInfo> { + <b>@Name("userId")</b> + long getUserInfoID(); + void setUserInfoID(long id); + + ... + } + </pre> + + The first character of a name must be a <code>unicode identifier start</code>, and all + subsequent characters must be a <code>unicode identifier part</code>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Fang Chen, Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Name.html#value()">value</a></strong></code> +<div class="block">Name assigned to the property.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String value</pre> +<div class="block">Name assigned to the property.</div> +</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/Name.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/MismatchException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Name.html" target="_top">Frames</a></li> +<li><a href="Name.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/NonDurableCommitException.html b/apidocs/com/amazon/carbonado/NonDurableCommitException.html new file mode 100644 index 0000000..7197b61 --- /dev/null +++ b/apidocs/com/amazon/carbonado/NonDurableCommitException.html @@ -0,0 +1,313 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>NonDurableCommitException (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="NonDurableCommitException (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/NonDurableCommitException.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/Name.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/NonDurableCommitException.html" target="_top">Frames</a></li> +<li><a href="NonDurableCommitException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class NonDurableCommitException" class="title">Class NonDurableCommitException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.NonDurableCommitException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">NonDurableCommitException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Thrown during a transaction commit if durability guarantees cannot be met. + In a replication system, this exception can indicate that some replicas have + not yet acknowledged the commit. They may still complete normally, but at an + indeterminate time.</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="../../../serialized-form.html#com.amazon.carbonado.NonDurableCommitException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/NonDurableCommitException.html#NonDurableCommitException()">NonDurableCommitException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/NonDurableCommitException.html#NonDurableCommitException(java.lang.String)">NonDurableCommitException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/NonDurableCommitException.html#NonDurableCommitException(java.lang.String, java.lang.Throwable)">NonDurableCommitException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/NonDurableCommitException.html#NonDurableCommitException(java.lang.Throwable)">NonDurableCommitException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="NonDurableCommitException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NonDurableCommitException</h4> +<pre>public NonDurableCommitException()</pre> +</li> +</ul> +<a name="NonDurableCommitException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NonDurableCommitException</h4> +<pre>public NonDurableCommitException(java.lang.String message)</pre> +</li> +</ul> +<a name="NonDurableCommitException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NonDurableCommitException</h4> +<pre>public NonDurableCommitException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="NonDurableCommitException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NonDurableCommitException</h4> +<pre>public NonDurableCommitException(java.lang.Throwable cause)</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/NonDurableCommitException.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/Name.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/NonDurableCommitException.html" target="_top">Frames</a></li> +<li><a href="NonDurableCommitException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/Nullable.html b/apidocs/com/amazon/carbonado/Nullable.html new file mode 100644 index 0000000..e79f407 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Nullable.html @@ -0,0 +1,177 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Nullable (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="Nullable (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/Nullable.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/NonDurableCommitException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Nullable.html" target="_top">Frames</a></li> +<li><a href="Nullable.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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</div> +<h2 title="Annotation Type Nullable" class="title">Annotation Type Nullable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +public @interface <span class="strong">Nullable</span></pre> +<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. By + default, all Storable properties are required to have a non-null value. It + is illegal to declare a property as nullable whose type is a primitive + non-object. + + <p>Example:<pre> + public interface UserInfo extends Storable<UserInfo> { + <b>@Nullable</b> + String getName(); + void setName(String name); + + ... + } + </pre> + + <p>If the repository does not allow a property to be declared as nullable + because the underlying schema differs, it can be also annotated as <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a>. This makes it easier for a common set of Storables to interact + with schemas which are slightly different. Attempting to persist null into a + property for which null is not allowed will likely result in a constraint + exception.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</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/Nullable.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/NonDurableCommitException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Nullable.html" target="_top">Frames</a></li> +<li><a href="Nullable.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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> diff --git a/apidocs/com/amazon/carbonado/OptimisticLockException.html b/apidocs/com/amazon/carbonado/OptimisticLockException.html new file mode 100644 index 0000000..9028548 --- /dev/null +++ b/apidocs/com/amazon/carbonado/OptimisticLockException.html @@ -0,0 +1,427 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>OptimisticLockException (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="OptimisticLockException (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/OptimisticLockException.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/Nullable.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/OptimisticLockException.html" target="_top">Frames</a></li> +<li><a href="OptimisticLockException.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><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</div> +<h2 title="Class OptimisticLockException" class="title">Class OptimisticLockException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.OptimisticLockException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">OptimisticLockException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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. + This exception may also be thrown if multiversion concurrency control (MVCC) + is being used and the commit fails.</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="../../../serialized-form.html#com.amazon.carbonado.OptimisticLockException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/OptimisticLockException.html#OptimisticLockException()">OptimisticLockException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(long)">OptimisticLockException</a></strong>(long expectedVersion)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object)">OptimisticLockException</a></strong>(java.lang.Object expectedVersion)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object, java.lang.Object)">OptimisticLockException</a></strong>(java.lang.Object expectedVersion, + java.lang.Object savedVersion)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object, java.lang.Object, com.amazon.carbonado.Storable)">OptimisticLockException</a></strong>(java.lang.Object expectedVersion, + java.lang.Object savedVersion, + <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object, com.amazon.carbonado.Storable, java.lang.Object)">OptimisticLockException</a></strong>(java.lang.Object savedVersion, + <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s, + java.lang.Object newVersion)</code> +<div class="block">Construct exception for when new version was expected to have increased.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.String)">OptimisticLockException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.String, java.lang.Throwable)">OptimisticLockException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Throwable)">OptimisticLockException</a></strong>(java.lang.Throwable cause)</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/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/OptimisticLockException.html#getStorable()">getStorable</a></strong>()</code> +<div class="block">Returns the Storable which was acted upon, or null if not available.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="OptimisticLockException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException()</pre> +</li> +</ul> +<a name="OptimisticLockException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException(java.lang.String message)</pre> +</li> +</ul> +<a name="OptimisticLockException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="OptimisticLockException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException(java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="OptimisticLockException(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException(long expectedVersion)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedVersion</code> - version number that was expected for persistent + record when update was executed</dd></dl> +</li> +</ul> +<a name="OptimisticLockException(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException(java.lang.Object expectedVersion)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedVersion</code> - version number that was expected for persistent + record when update was executed</dd></dl> +</li> +</ul> +<a name="OptimisticLockException(java.lang.Object, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException(java.lang.Object expectedVersion, + java.lang.Object savedVersion)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedVersion</code> - version number that was expected for persistent + record when update was executed</dd><dd><code>savedVersion</code> - actual persistent version number of storable</dd></dl> +</li> +</ul> +<a name="OptimisticLockException(java.lang.Object, java.lang.Object, com.amazon.carbonado.Storable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException(java.lang.Object expectedVersion, + java.lang.Object savedVersion, + <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expectedVersion</code> - version number that was expected for persistent + record when update was executed</dd><dd><code>savedVersion</code> - actual persistent version number of storable</dd><dd><code>s</code> - Storable which was acted upon</dd></dl> +</li> +</ul> +<a name="OptimisticLockException(java.lang.Object, com.amazon.carbonado.Storable, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OptimisticLockException</h4> +<pre>public OptimisticLockException(java.lang.Object savedVersion, + <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s, + java.lang.Object newVersion)</pre> +<div class="block">Construct exception for when new version was expected to have increased.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>savedVersion</code> - actual persistent version number of storable</dd><dd><code>s</code> - Storable which was acted upon</dd><dd><code>newVersion</code> - new version which was provided</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="getStorable()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getStorable</h4> +<pre>public <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> getStorable()</pre> +<div class="block">Returns the Storable which was acted upon, or null if not available.</div> +</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/OptimisticLockException.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/Nullable.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/OptimisticLockException.html" target="_top">Frames</a></li> +<li><a href="OptimisticLockException.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><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> diff --git a/apidocs/com/amazon/carbonado/PartitionKey.html b/apidocs/com/amazon/carbonado/PartitionKey.html new file mode 100644 index 0000000..d6b9e6a --- /dev/null +++ b/apidocs/com/amazon/carbonado/PartitionKey.html @@ -0,0 +1,228 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PartitionKey (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="PartitionKey (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/PartitionKey.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/OptimisticLockException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PartitionKey.html" target="_top">Frames</a></li> +<li><a href="PartitionKey.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type PartitionKey" class="title">Annotation Type PartitionKey</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=TYPE) +public @interface <span class="strong">PartitionKey</span></pre> +<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. + This key is ignored if the underlying repository lacks support for partitioning. + + <p>Example:<pre> + @PrimaryKey("userInfoID") + <b>@PartitionKey("userInfoGroup")</b> + public interface UserInfo extends Storable<UserInfo> { + long getUserInfoID(); + void setUserInfoID(long id); + + String getUserInfoGroup(); + void setUserInfoGroup(String group); + + ... + } + </pre></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Archit Shivaprakash</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/PartitionKey.html#value()">value</a></strong></code> +<div class="block">A list of property names.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String[] value</pre> +<div class="block">A list of property names.</div> +<dl> +<dt>Default:</dt> +<dd>{}</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/PartitionKey.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/OptimisticLockException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PartitionKey.html" target="_top">Frames</a></li> +<li><a href="PartitionKey.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/PersistDeadlockException.html b/apidocs/com/amazon/carbonado/PersistDeadlockException.html new file mode 100644 index 0000000..f85714f --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistDeadlockException.html @@ -0,0 +1,349 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PersistDeadlockException (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="PersistDeadlockException (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/PersistDeadlockException.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/PartitionKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistDeadlockException.html" target="_top">Frames</a></li> +<li><a href="PersistDeadlockException.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><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</div> +<h2 title="Class PersistDeadlockException" class="title">Class PersistDeadlockException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.PersistDeadlockException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PersistDeadlockException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Thrown if a persist operation fails because it was selected to resolve a + deadlock.</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="../../../serialized-form.html#com.amazon.carbonado.PersistDeadlockException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/PersistDeadlockException.html#PersistDeadlockException()">PersistDeadlockException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistDeadlockException.html#PersistDeadlockException(java.lang.String)">PersistDeadlockException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistDeadlockException.html#PersistDeadlockException(java.lang.String, java.lang.Throwable)">PersistDeadlockException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistDeadlockException.html#PersistDeadlockException(java.lang.Throwable)">PersistDeadlockException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/PersistDeadlockException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="PersistDeadlockException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistDeadlockException</h4> +<pre>public PersistDeadlockException()</pre> +</li> +</ul> +<a name="PersistDeadlockException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistDeadlockException</h4> +<pre>public PersistDeadlockException(java.lang.String message)</pre> +</li> +</ul> +<a name="PersistDeadlockException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistDeadlockException</h4> +<pre>public PersistDeadlockException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="PersistDeadlockException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PersistDeadlockException</h4> +<pre>public PersistDeadlockException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makeFetchException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makeFetchException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> makeFetchException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/PersistDeadlockException.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/PartitionKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistDeadlockException.html" target="_top">Frames</a></li> +<li><a href="PersistDeadlockException.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><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> diff --git a/apidocs/com/amazon/carbonado/PersistDeniedException.html b/apidocs/com/amazon/carbonado/PersistDeniedException.html new file mode 100644 index 0000000..8eb08b9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistDeniedException.html @@ -0,0 +1,311 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PersistDeniedException (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="PersistDeniedException (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/PersistDeniedException.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/PersistDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistDeniedException.html" target="_top">Frames</a></li> +<li><a href="PersistDeniedException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class PersistDeniedException" class="title">Class PersistDeniedException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.PersistDeniedException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PersistDeniedException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.PersistDeniedException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/PersistDeniedException.html#PersistDeniedException()">PersistDeniedException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistDeniedException.html#PersistDeniedException(java.lang.String)">PersistDeniedException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistDeniedException.html#PersistDeniedException(java.lang.String, java.lang.Throwable)">PersistDeniedException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistDeniedException.html#PersistDeniedException(java.lang.Throwable)">PersistDeniedException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="PersistDeniedException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistDeniedException</h4> +<pre>public PersistDeniedException()</pre> +</li> +</ul> +<a name="PersistDeniedException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistDeniedException</h4> +<pre>public PersistDeniedException(java.lang.String message)</pre> +</li> +</ul> +<a name="PersistDeniedException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistDeniedException</h4> +<pre>public PersistDeniedException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="PersistDeniedException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PersistDeniedException</h4> +<pre>public PersistDeniedException(java.lang.Throwable cause)</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/PersistDeniedException.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/PersistDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistDeniedException.html" target="_top">Frames</a></li> +<li><a href="PersistDeniedException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/PersistException.html b/apidocs/com/amazon/carbonado/PersistException.html new file mode 100644 index 0000000..ed4e04d --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistException.html @@ -0,0 +1,310 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PersistException (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="PersistException (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/PersistException.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/PersistDeniedException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistException.html" target="_top">Frames</a></li> +<li><a href="PersistException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class PersistException" class="title">Class PersistException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.PersistException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a>, <a href="../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">NonDurableCommitException</a>, <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a>, <a href="../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a>, <a href="../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a>, <a href="../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a>, <a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a>, <a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a>, <a href="../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a>, <a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PersistException</span> +extends <a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.PersistException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/PersistException.html#PersistException()">PersistException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistException.html#PersistException(java.lang.String)">PersistException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistException.html#PersistException(java.lang.String, java.lang.Throwable)">PersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistException.html#PersistException(java.lang.Throwable)">PersistException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="PersistException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistException</h4> +<pre>public PersistException()</pre> +</li> +</ul> +<a name="PersistException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistException</h4> +<pre>public PersistException(java.lang.String message)</pre> +</li> +</ul> +<a name="PersistException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistException</h4> +<pre>public PersistException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="PersistException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PersistException</h4> +<pre>public PersistException(java.lang.Throwable cause)</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/PersistException.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/PersistDeniedException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistException.html" target="_top">Frames</a></li> +<li><a href="PersistException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/PersistInterruptedException.html b/apidocs/com/amazon/carbonado/PersistInterruptedException.html new file mode 100644 index 0000000..e7c1002 --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistInterruptedException.html @@ -0,0 +1,350 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PersistInterruptedException (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="PersistInterruptedException (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/PersistInterruptedException.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/PersistException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistInterruptedException.html" target="_top">Frames</a></li> +<li><a href="PersistInterruptedException.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><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</div> +<h2 title="Class PersistInterruptedException" class="title">Class PersistInterruptedException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.PersistInterruptedException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PersistInterruptedException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Thrown from a persist operation that was canceled.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#com.amazon.carbonado.PersistInterruptedException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/PersistInterruptedException.html#PersistInterruptedException()">PersistInterruptedException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistInterruptedException.html#PersistInterruptedException(java.lang.String)">PersistInterruptedException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistInterruptedException.html#PersistInterruptedException(java.lang.String, java.lang.Throwable)">PersistInterruptedException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistInterruptedException.html#PersistInterruptedException(java.lang.Throwable)">PersistInterruptedException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/PersistInterruptedException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="PersistInterruptedException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistInterruptedException</h4> +<pre>public PersistInterruptedException()</pre> +</li> +</ul> +<a name="PersistInterruptedException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistInterruptedException</h4> +<pre>public PersistInterruptedException(java.lang.String message)</pre> +</li> +</ul> +<a name="PersistInterruptedException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistInterruptedException</h4> +<pre>public PersistInterruptedException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="PersistInterruptedException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PersistInterruptedException</h4> +<pre>public PersistInterruptedException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makeFetchException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makeFetchException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> makeFetchException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/PersistInterruptedException.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/PersistException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistInterruptedException.html" target="_top">Frames</a></li> +<li><a href="PersistInterruptedException.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><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> diff --git a/apidocs/com/amazon/carbonado/PersistMultipleException.html b/apidocs/com/amazon/carbonado/PersistMultipleException.html new file mode 100644 index 0000000..f2ccc97 --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistMultipleException.html @@ -0,0 +1,349 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PersistMultipleException (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="PersistMultipleException (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/PersistMultipleException.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/PersistInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistMultipleException.html" target="_top">Frames</a></li> +<li><a href="PersistMultipleException.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><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</div> +<h2 title="Class PersistMultipleException" class="title">Class PersistMultipleException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.PersistMultipleException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PersistMultipleException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.PersistMultipleException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/PersistMultipleException.html#PersistMultipleException()">PersistMultipleException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistMultipleException.html#PersistMultipleException(java.lang.String)">PersistMultipleException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistMultipleException.html#PersistMultipleException(java.lang.String, java.lang.Throwable)">PersistMultipleException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistMultipleException.html#PersistMultipleException(java.lang.Throwable)">PersistMultipleException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/PersistMultipleException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="PersistMultipleException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistMultipleException</h4> +<pre>public PersistMultipleException()</pre> +</li> +</ul> +<a name="PersistMultipleException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistMultipleException</h4> +<pre>public PersistMultipleException(java.lang.String message)</pre> +</li> +</ul> +<a name="PersistMultipleException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistMultipleException</h4> +<pre>public PersistMultipleException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="PersistMultipleException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PersistMultipleException</h4> +<pre>public PersistMultipleException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makeFetchException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makeFetchException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> makeFetchException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/PersistMultipleException.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/PersistInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistMultipleException.html" target="_top">Frames</a></li> +<li><a href="PersistMultipleException.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><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> diff --git a/apidocs/com/amazon/carbonado/PersistNoneException.html b/apidocs/com/amazon/carbonado/PersistNoneException.html new file mode 100644 index 0000000..3aa633d --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistNoneException.html @@ -0,0 +1,349 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PersistNoneException (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="PersistNoneException (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/PersistNoneException.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/PersistMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistNoneException.html" target="_top">Frames</a></li> +<li><a href="PersistNoneException.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><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</div> +<h2 title="Class PersistNoneException" class="title">Class PersistNoneException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.PersistNoneException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PersistNoneException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">A PersistNoneException is thrown when a persist operation applied to no + records when at least one was expected.</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="../../../serialized-form.html#com.amazon.carbonado.PersistNoneException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/PersistNoneException.html#PersistNoneException()">PersistNoneException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistNoneException.html#PersistNoneException(java.lang.String)">PersistNoneException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistNoneException.html#PersistNoneException(java.lang.String, java.lang.Throwable)">PersistNoneException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistNoneException.html#PersistNoneException(java.lang.Throwable)">PersistNoneException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/PersistNoneException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="PersistNoneException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistNoneException</h4> +<pre>public PersistNoneException()</pre> +</li> +</ul> +<a name="PersistNoneException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistNoneException</h4> +<pre>public PersistNoneException(java.lang.String message)</pre> +</li> +</ul> +<a name="PersistNoneException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistNoneException</h4> +<pre>public PersistNoneException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="PersistNoneException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PersistNoneException</h4> +<pre>public PersistNoneException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makeFetchException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makeFetchException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> makeFetchException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/PersistNoneException.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/PersistMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistNoneException.html" target="_top">Frames</a></li> +<li><a href="PersistNoneException.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><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> diff --git a/apidocs/com/amazon/carbonado/PersistTimeoutException.html b/apidocs/com/amazon/carbonado/PersistTimeoutException.html new file mode 100644 index 0000000..c9df69e --- /dev/null +++ b/apidocs/com/amazon/carbonado/PersistTimeoutException.html @@ -0,0 +1,348 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PersistTimeoutException (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="PersistTimeoutException (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/PersistTimeoutException.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/PersistNoneException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistTimeoutException.html" target="_top">Frames</a></li> +<li><a href="PersistTimeoutException.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><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</div> +<h2 title="Class PersistTimeoutException" class="title">Class PersistTimeoutException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.PersistTimeoutException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PersistTimeoutException</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Thrown if a persist operation fails because lock acquisition timed out.</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="../../../serialized-form.html#com.amazon.carbonado.PersistTimeoutException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/PersistTimeoutException.html#PersistTimeoutException()">PersistTimeoutException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistTimeoutException.html#PersistTimeoutException(java.lang.String)">PersistTimeoutException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistTimeoutException.html#PersistTimeoutException(java.lang.String, java.lang.Throwable)">PersistTimeoutException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/PersistTimeoutException.html#PersistTimeoutException(java.lang.Throwable)">PersistTimeoutException</a></strong>(java.lang.Throwable cause)</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>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/PersistTimeoutException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="PersistTimeoutException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistTimeoutException</h4> +<pre>public PersistTimeoutException()</pre> +</li> +</ul> +<a name="PersistTimeoutException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistTimeoutException</h4> +<pre>public PersistTimeoutException(java.lang.String message)</pre> +</li> +</ul> +<a name="PersistTimeoutException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PersistTimeoutException</h4> +<pre>public PersistTimeoutException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="PersistTimeoutException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PersistTimeoutException</h4> +<pre>public PersistTimeoutException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makeFetchException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makeFetchException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> makeFetchException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">RepositoryException</a></code></strong></div> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></code> in class <code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/PersistTimeoutException.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/PersistNoneException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PersistTimeoutException.html" target="_top">Frames</a></li> +<li><a href="PersistTimeoutException.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><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> diff --git a/apidocs/com/amazon/carbonado/PrimaryKey.html b/apidocs/com/amazon/carbonado/PrimaryKey.html new file mode 100644 index 0000000..d916a4f --- /dev/null +++ b/apidocs/com/amazon/carbonado/PrimaryKey.html @@ -0,0 +1,225 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>PrimaryKey (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="PrimaryKey (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/PrimaryKey.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/PersistTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PrimaryKey.html" target="_top">Frames</a></li> +<li><a href="PrimaryKey.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type PrimaryKey" class="title">Annotation Type PrimaryKey</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=TYPE) +public @interface <span class="strong">PrimaryKey</span></pre> +<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. All Storable types must have at least one property belonging to the + primary key. + + <p>Example:<pre> + <b>@PrimaryKey</b>("userInfoID") + public interface UserInfo extends Storable<UserInfo> { + long getUserInfoID(); + void setUserInfoID(long id); + + ... + } + </pre></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/AlternateKeys.html" title="annotation in com.amazon.carbonado"><code>AlternateKeys</code></a>, +<a href="../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/PrimaryKey.html#value()">value</a></strong></code> +<div class="block">A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String[] value</pre> +<div class="block">A list of property names, which may be prefixed with '+' or '-' to + indicate a preference for ascending or descending order.</div> +</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/PrimaryKey.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/PersistTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/PrimaryKey.html" target="_top">Frames</a></li> +<li><a href="PrimaryKey.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/Query.Controller.html b/apidocs/com/amazon/carbonado/Query.Controller.html new file mode 100644 index 0000000..1b949aa --- /dev/null +++ b/apidocs/com/amazon/carbonado/Query.Controller.html @@ -0,0 +1,307 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Query.Controller (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="Query.Controller (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/Query.Controller.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/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Query.Controller.html" target="_top">Frames</a></li> +<li><a href="Query.Controller.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</div> +<h2 title="Interface Query.Controller" class="title">Interface Query.Controller</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.lang.AutoCloseable, java.io.Closeable, java.io.Serializable</dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">Query.Controller</span> +extends java.io.Serializable, java.io.Closeable</pre> +<div class="block">Controller instance can be used to abort query operations. + + <p>Example:<pre> + Storage<UserInfo> users = ... + long count = users.query("name = ?").count(Query.Timeout.seconds(10)); + </pre></div> +</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/Query.Controller.html#begin()">begin</a></strong>()</code> +<div class="block">Called by query when it begins, possibly multiple times.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#close()">close</a></strong>()</code> +<div class="block">Always called by query when finished, even when it fails.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#continueCheck()">continueCheck</a></strong>()</code> +<div class="block">Periodically called by query to determine if it should continue.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeout()">getTimeout</a></strong>()</code> +<div class="block">Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.concurrent.TimeUnit</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeoutUnit()">getTimeoutUnit</a></strong>()</code> +<div class="block">Returns the unit for the timeout, if applicable.</div> +</td> +</tr> +</table> +</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="getTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeout</h4> +<pre>long getTimeout()</pre> +<div class="block">Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.</div> +</li> +</ul> +<a name="getTimeoutUnit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeoutUnit</h4> +<pre>java.util.concurrent.TimeUnit getTimeoutUnit()</pre> +<div class="block">Returns the unit for the timeout, if applicable.</div> +</li> +</ul> +<a name="begin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>begin</h4> +<pre>void begin()</pre> +<div class="block">Called by query when it begins, possibly multiple times. Implementation + is required to be idempotent and ignore multiple invocations.</div> +</li> +</ul> +<a name="continueCheck()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>continueCheck</h4> +<pre>void continueCheck() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Periodically called by query to determine if it should continue.</div> +<dl><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="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block">Always called by query when finished, even when it fails. Implementation + is required to be idempotent and ignore multiple invocations.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</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/Query.Controller.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/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Query.Controller.html" target="_top">Frames</a></li> +<li><a href="Query.Controller.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> diff --git a/apidocs/com/amazon/carbonado/Query.Timeout.html b/apidocs/com/amazon/carbonado/Query.Timeout.html new file mode 100644 index 0000000..0f6d511 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Query.Timeout.html @@ -0,0 +1,493 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Query.Timeout (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="Query.Timeout (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/Query.Timeout.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/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Query.Timeout.html" target="_top">Frames</a></li> +<li><a href="Query.Timeout.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><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</div> +<h2 title="Class Query.Timeout" class="title">Class Query.Timeout</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.Query.Timeout</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/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable</dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static final class <span class="strong">Query.Timeout</span> +extends java.lang.Object +implements <a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></pre> +<div class="block">Timeout controller, for aborting long running queries. One instance is + good for one timeout. The instance can be shared by multiple queries, if + they are part of a single logical operation. + + <p>The timeout applies to the entire duration of fetching results, not + just the time spent between individual fetches. A caller which is slowly + processing results can timeout. More sophisticated timeouts can be + implemented using custom Controller implementations.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#com.amazon.carbonado.Query.Timeout">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/Query.Timeout.html#Query.Timeout(long, java.util.concurrent.TimeUnit)">Query.Timeout</a></strong>(long timeout, + java.util.concurrent.TimeUnit unit)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#begin()">begin</a></strong>()</code> +<div class="block">Called by query when it begins, possibly multiple times.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#close()">close</a></strong>()</code> +<div class="block">Always called by query when finished, even when it fails.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#continueCheck()">continueCheck</a></strong>()</code> +<div class="block">Periodically called by query to determine if it should continue.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#getTimeout()">getTimeout</a></strong>()</code> +<div class="block">Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.concurrent.TimeUnit</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#getTimeoutUnit()">getTimeoutUnit</a></strong>()</code> +<div class="block">Returns the unit for the timeout, if applicable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#hours(long)">hours</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in hours.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#micros(long)">micros</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in microseconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#millis(long)">millis</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in milliseconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#minutes(long)">minutes</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in minutes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#nanos(long)">nanos</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in nanoseconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html#seconds(long)">seconds</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in seconds.</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/Query.Timeout.html#toString()">toString</a></strong>()</code> </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, wait, wait, wait</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="Query.Timeout(long, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Query.Timeout</h4> +<pre>public Query.Timeout(long timeout, + java.util.concurrent.TimeUnit unit)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="nanos(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nanos</h4> +<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> nanos(long timeout)</pre> +<div class="block">Return a new Timeout in nanoseconds.</div> +</li> +</ul> +<a name="micros(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>micros</h4> +<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> micros(long timeout)</pre> +<div class="block">Return a new Timeout in microseconds.</div> +</li> +</ul> +<a name="millis(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>millis</h4> +<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> millis(long timeout)</pre> +<div class="block">Return a new Timeout in milliseconds.</div> +</li> +</ul> +<a name="seconds(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>seconds</h4> +<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> seconds(long timeout)</pre> +<div class="block">Return a new Timeout in seconds.</div> +</li> +</ul> +<a name="minutes(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>minutes</h4> +<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> minutes(long timeout)</pre> +<div class="block">Return a new Timeout in minutes.</div> +</li> +</ul> +<a name="hours(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hours</h4> +<pre>public static <a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> hours(long timeout)</pre> +<div class="block">Return a new Timeout in hours.</div> +</li> +</ul> +<a name="getTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeout</h4> +<pre>public long getTimeout()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeout()">Query.Controller</a></code></strong></div> +<div class="block">Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeout()">getTimeout</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd> +</dl> +</li> +</ul> +<a name="getTimeoutUnit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeoutUnit</h4> +<pre>public java.util.concurrent.TimeUnit getTimeoutUnit()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeoutUnit()">Query.Controller</a></code></strong></div> +<div class="block">Returns the unit for the timeout, if applicable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#getTimeoutUnit()">getTimeoutUnit</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd> +</dl> +</li> +</ul> +<a name="begin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>begin</h4> +<pre>public void begin()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#begin()">Query.Controller</a></code></strong></div> +<div class="block">Called by query when it begins, possibly multiple times. Implementation + is required to be idempotent and ignore multiple invocations.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#begin()">begin</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd> +</dl> +</li> +</ul> +<a name="continueCheck()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>continueCheck</h4> +<pre>public void continueCheck() + throws <a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#continueCheck()">Query.Controller</a></code></strong></div> +<div class="block">Periodically called by query to determine if it should continue.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#continueCheck()">continueCheck</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/amazon/carbonado/Query.Controller.html#close()">Query.Controller</a></code></strong></div> +<div class="block">Always called by query when finished, even when it fails. Implementation + is required to be idempotent and ignore multiple invocations.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/amazon/carbonado/Query.Controller.html#close()">close</a></code> in interface <code><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/Query.Timeout.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/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Query.Timeout.html" target="_top">Frames</a></li> +<li><a href="Query.Timeout.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><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> diff --git a/apidocs/com/amazon/carbonado/Query.html b/apidocs/com/amazon/carbonado/Query.html new file mode 100644 index 0000000..9b7d5af --- /dev/null +++ b/apidocs/com/amazon/carbonado/Query.html @@ -0,0 +1,1431 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Query (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="Query (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/Query.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/PrimaryKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Query.html" target="_top">Frames</a></li> +<li><a href="Query.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>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</div> +<h2 title="Interface Query" class="title">Interface Query<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 Known Implementing Classes:</dt> +<dd><a href="../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a>, <a href="../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a>, <a href="../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Query<S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<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. + Queries are immutable representations of an action – they do not + contain any Storable instances. The apparent mutators (with, et al) do not + actually modify the Query. Instead, they return another Query instance which + has the requested modification. To obtain an initial Query instance, call + one of the <a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a> query methods. + + <p>Query objects are usually compiled and cached, and the same instance can + be re-used for future queries. This is possible because queries are + immutable and naturally thread-safe.</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"> +<!-- ======== 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">Interface 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/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></strong></code> +<div class="block">Controller instance can be used to abort query operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></strong></code> +<div class="block">Timeout controller, for aborting long running queries.</div> +</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><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#after(T)">after</a></strong>(T start)</code> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#and(java.lang.String)">and</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#count()">count</a></strong>()</code> +<div class="block">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#deleteAll()">deleteAll</a></strong>()</code> +<div class="block">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#deleteOne()">deleteOne</a></strong>()</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#exists()">exists</a></strong>()</code> +<div class="block">Returns true if any results are matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns true if any results are matched by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetch()">fetch</a></strong>()</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetchAfter(T)">fetchAfter</a></strong>(T start)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#getBlankParameterCount()">getBlankParameterCount</a></strong>()</code> +<div class="block">Returns the amount of blank parameters that need to be filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the query's filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues</a></strong>()</code> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#loadOne()">loadOne</a></strong>()</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#not()">not</a></strong>()</code> +<div class="block">Returns a new query which produces all the results not supplied in this + query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#or(java.lang.String)">or</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> +<div class="block">Returns a copy of this query ordered by specific property values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> +<div class="block">Returns a copy of this query ordered by a specific property value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printNative()">printNative</a></strong>()</code> +<div class="block">Print the native query to standard out, which is useful for performance + analysis.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable)">printNative</a></strong>(java.lang.Appendable app)</code> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable, int)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printPlan()">printPlan</a></strong>()</code> +<div class="block">Prints the query excecution plan to standard out, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable)">printPlan</a></strong>(java.lang.Appendable app)</code> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable, int)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis.</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/Query.html#toString()">toString</a></strong>()</code> +<div class="block">Returns a description of the query filter and any other arguments.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#tryDeleteOne()">tryDeleteOne</a></strong>()</code> +<div class="block">Deletes zero or one matching objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes zero or one matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#tryLoadOne()">tryLoadOne</a></strong>()</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></strong>(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Returns a copy of this Query with the next blank parameters filled in.</div> +</td> +</tr> +</table> +</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> getStorableType()</pre> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</li> +</ul> +<a name="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre><a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> getFilter()</pre> +<div class="block">Returns the query's filter.</div> +</li> +</ul> +<a name="getFilterValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterValues</h4> +<pre><a href="../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> getFilterValues()</pre> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +</li> +</ul> +<a name="getBlankParameterCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlankParameterCount</h4> +<pre>int getBlankParameterCount()</pre> +<div class="block">Returns the amount of blank parameters that need to be filled in. If + zero, then this query is ready to be used.</div> +</li> +</ul> +<a name="with(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(int value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(long value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(float value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(double value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(boolean value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(char value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(byte)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(byte value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(short)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(short value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> with(java.lang.Object value)</pre> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="withValues(java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withValues</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> withValues(java.lang.Object... values)</pre> +<div class="block">Returns a copy of this Query with the next blank parameters filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - parameter values to fill in; if null or empty, this + Query instance is returned</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters or if too many + parameter values supplied</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if any type doesn't match</dd></dl> +</li> +</ul> +<a name="and(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> and(java.lang.String filter) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter expression</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query, or + if this query is already guaranteed to fetch nothing</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></code> - if expression is malformed</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl> +</li> +</ul> +<a name="and(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> and(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query, or + if this query is already guaranteed to fetch nothing</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl> +</li> +</ul> +<a name="or(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> or(java.lang.String filter) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter expression</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query, or + if this query is already guaranteed to fetch everything</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></code> - if expression is malformed</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl> +</li> +</ul> +<a name="or(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> or(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new query which has another <a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query, or + if this query is already guaranteed to fetch everything</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl> +</li> +</ul> +<a name="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> not() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new query which produces all the results not supplied in this + query. Any filled in parameters in this query are copied into the new + one.</div> +<dl><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> - if storage layer throws an exception</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if new query is unsupported by repository</dd></dl> +</li> +</ul> +<a name="orderBy(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> orderBy(java.lang.String property) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + + <p>Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - name of property to order by</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if property is null or is not a member + of type S</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if given ordering, combined with + query filter, is unsupported by repository</dd></dl> +</li> +</ul> +<a name="orderBy(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> orderBy(java.lang.String... properties) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + + <p>Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - names of properties to order by</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if any property is null or is not a + member of type S</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if given ordering, combined with + query filter, is unsupported by repository</dd></dl> +</li> +</ul> +<a name="after(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="after(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>after</h4> +<pre><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> after(T start) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor. This is only + effective when query has been given an explicit <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total ordering, then query may start at an earlier + position. + + <p>Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, this query is + returned</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="fetch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetch() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>fetch results</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetch(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a></dd></dl> +</li> +</ul> +<a name="fetchSlice(long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetchSlice(long from, + java.lang.Long to) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a> in order for the slice results to be deterministic.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if <code>from</code> is negative or if + <code>from</code> is more than <code>to</code></dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre><a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetchSlice(long from, + java.lang.Long to, + <a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a> in order for the slice results to be deterministic.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if <code>from</code> is negative or if + <code>from</code> is more than <code>to</code></dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="fetchAfter(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="fetchAfter(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchAfter</h4> +<pre><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetchAfter(T start) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total + ordering, then cursor may start at an earlier position. + + <p>Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + + <p>Calling <code>fetchAfter(s)</code> is equivalent to calling <code>after(s).fetch()</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, fetch all results</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>, +<a href="../../../com/amazon/carbonado/Query.html#after(T)"><code>after(T)</code></a></dd></dl> +</li> +</ul> +<a name="fetchAfter(com.amazon.carbonado.Storable,com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a><a name="fetchAfter(T, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchAfter</h4> +<pre><T extends <a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> fetchAfter(T start, + <a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit <a href="../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total + ordering, then cursor may start at an earlier position. + + <p>Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + + <p>Calling <code>fetchAfter(s)</code> is equivalent to calling <code>after(s).fetch()</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, fetch all results</dd><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>, +<a href="../../../com/amazon/carbonado/Query.html#after(T)"><code>after(T)</code></a></dd></dl> +</li> +</ul> +<a name="loadOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadOne</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> loadOne() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="loadOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadOne</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> loadOne(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryLoadOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryLoadOne</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> tryLoadOne() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null or a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryLoadOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryLoadOne</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> tryLoadOne(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>null or a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteOne</h4> +<pre>void deleteOne() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteOne</h4> +<pre>void deleteOne(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryDeleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>boolean tryDeleteOne() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryDeleteOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>boolean tryDeleteOne(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>void deleteAll() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteAll(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>void deleteAll(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>long count() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>count of matches</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>long count(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>count of matches</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="exists()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>boolean exists() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns true if any results are matched by this query.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if any matches</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="exists(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>boolean exists(<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns true if any results are matched by this query.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if any matches</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any blank parameters in this query</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="printNative()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>boolean printNative()</pre> +<div class="block">Print the native query to standard out, which is useful for performance + analysis. Not all repositories have a native query format. An example + native format is SQL.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>boolean printNative(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>boolean printNative(java.lang.Appendable app, + int indentLevel) + throws java.io.IOException</pre> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>boolean printPlan()</pre> +<div class="block">Prints the query excecution plan to standard out, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>boolean printPlan(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>boolean printPlan(java.lang.Appendable app, + int indentLevel) + throws java.io.IOException</pre> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>java.lang.String toString()</pre> +<div class="block">Returns a description of the query filter and any other arguments.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/Query.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/PrimaryKey.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Query.html" target="_top">Frames</a></li> +<li><a href="Query.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>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> diff --git a/apidocs/com/amazon/carbonado/Repository.html b/apidocs/com/amazon/carbonado/Repository.html new file mode 100644 index 0000000..74fa5d3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Repository.html @@ -0,0 +1,422 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Repository (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="Repository (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/Repository.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/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Repository.html" target="_top">Frames</a></li> +<li><a href="Repository.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</div> +<h2 title="Interface Repository" class="title">Interface Repository</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Repository</span></pre> +<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. Some repositories do not have control over the schema (for example, a JDBC + Repository depends on the schema defined by the underlying relational database); such + repositories are called "dependent". Conversely, a repository which has complete control + over the schema is termed "independent". + + <P>A dependent repository requires and will verify that Storables + have a matching definition in the external storage layer. An independent + repository will automatically update type definitions in its database to + match changes to Storable definitions. + + <p>Repository instances should be thread-safe and immutable. Therefore, it + is safe for multiple threads to be interacting with a Repository.</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/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><code>RepositoryBuilder</code></a></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/Repository.html#close()">close</a></strong>()</code> +<div class="block">Closes this repository reference, aborting any current + transactions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Repository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction()">enterTransaction</a></strong>()</code> +<div class="block">Causes the current thread to enter a transaction scope.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><C extends <a href="../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> <br>C</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)">getCapability</a></strong>(java.lang.Class<C> capabilityType)</code> +<div class="block">Requests a specific capability of this Repository.</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/Repository.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of this repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Repository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +</td> +</tr> +</table> +</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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of this repository.</div> +</li> +</ul> +<a name="storageFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>storageFor</h4> +<pre><S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> storageFor(java.lang.Class<S> type) + throws <a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>specific type of Storage instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if specified type is null</dd> +<dd><code><a href="../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if specified type is not suitable</dd> +<dd><code><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if specified type cannot be supported</dd> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if storage layer throws any other kind of + exception</dd></dl> +</li> +</ul> +<a name="enterTransaction()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTransaction</h4> +<pre><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTransaction()</pre> +<div class="block">Causes the current thread to enter a transaction scope. Call commit + inside the transaction in order for any updates to the repository to be + applied. Be sure to call exit when leaving the scope. + <p> + To ensure exit is called, use transactions as follows: + <pre> + Transaction txn = repository.enterTransaction(); + try { + // Make updates to storage layer + ... + + // Commit the changes up to this point + txn.commit(); + + // Optionally make more updates + ... + + // Commit remaining changes + txn.commit(); + } finally { + // Ensure transaction exits, aborting uncommitted changes if an exception was thrown + txn.exit(); + } + </pre></div> +</li> +</ul> +<a name="enterTransaction(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTransaction</h4> +<pre><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTransaction(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level. The actual isolation level may be higher than + requested, if the repository does not support the exact level. If the + repository does not support a high enough level, it throws an + UnsupportedOperationException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - minimum desired transaction isolation level -- if null, a + suitable default is selected</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if repository does not support + isolation as high as the desired level</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction()"><code>enterTransaction()</code></a></dd></dl> +</li> +</ul> +<a name="enterTopTransaction(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTopTransaction</h4> +<pre><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTopTransaction(<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level. The actual isolation level may be + higher than requested, if the repository does not support the exact + level. If the repository does not support a high enough level, it throws + an UnsupportedOperationException. + + <p>This method requests a top-level transaction, which means it never + has a parent transaction, but it still can be a parent transaction + itself. This kind of transaction is useful when a commit must absolutely + succeed, even if the current thread is already in a transaction + scope. If there was a parent transaction, then a commit might still be + rolled back by the parent. + + <p>Requesting a top-level transaction can be deadlock prone if the + current thread is already in a transaction scope. The top-level + transaction may not be able to obtain locks held by the parent + transaction. An alternative to requesting top-level transactions is to + execute transactions in separate threads.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - minimum desired transaction isolation level -- if null, a + suitable default is selected</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if repository does not support + isolation as high as the desired level</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Repository.html#enterTransaction()"><code>enterTransaction()</code></a></dd></dl> +</li> +</ul> +<a name="getTransactionIsolationLevel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionIsolationLevel</h4> +<pre><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> getTransactionIsolationLevel()</pre> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +</li> +</ul> +<a name="getCapability(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCapability</h4> +<pre><C extends <a href="../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> C getCapability(java.lang.Class<C> capabilityType)</pre> +<div class="block">Requests a specific capability of this Repository. This allows + repositories to support extended features without having to clutter the + main repository interface. The list of supported capabilities is + documented with repository implementations.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capabilityType</code> - type of capability requested</dd> +<dt><span class="strong">Returns:</span></dt><dd>capability instance or null if not supported</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block">Closes this repository reference, aborting any current + transactions. Operations on objects returned by this repository will + fail when accessing the storage layer.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.SecurityException</code> - if caller does not have permission</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/Repository.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/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Repository.html" target="_top">Frames</a></li> +<li><a href="Repository.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> diff --git a/apidocs/com/amazon/carbonado/RepositoryBuilder.html b/apidocs/com/amazon/carbonado/RepositoryBuilder.html new file mode 100644 index 0000000..984be71 --- /dev/null +++ b/apidocs/com/amazon/carbonado/RepositoryBuilder.html @@ -0,0 +1,399 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RepositoryBuilder (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="RepositoryBuilder (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/RepositoryBuilder.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/Repository.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/RepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="RepositoryBuilder.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</div> +<h2 title="Interface RepositoryBuilder" class="title">Interface RepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a>, <a href="../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a>, <a href="../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a>, <a href="../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a>, <a href="../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a>, <a href="../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a>, <a href="../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">RepositoryBuilder</span></pre> +<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. All repository implementations should be constructable + via a builder that implements this interface. Builders should follow a + pattern where configuration is supplied via property access methods. With + this design, each item can have extensive documentation and optional + configuration can be ignored. + + <p>A builder design also offers advantages over constructors in that a + different repository can be built depending on the specific + configuration. This logic is hidden, making it easier to use repositories + that would otherwise require complex steps to construct. + + <p>RepositoryBuilders are not expected to be thread-safe, but the + Repositories they build are thread-safe.</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a></strong>(<a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> +<div class="block">Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryBuilder.html#build()">build</a></strong>()</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootReference)</code> +<div class="block">Builds a repository instance.</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/RepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Iterable<<a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a></strong>()</code> +<div class="block">Returns all the TriggerFactories which were added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></strong>(<a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> +<div class="block">Remove a TriggerFactory which was added earlier.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +</table> +</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="build()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build() + throws <a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a>, + <a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Builds a repository instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre><a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootReference) + throws <a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a>, + <a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootReference</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>void setName(java.lang.String name)</pre> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>boolean isMaster()</pre> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>void setMaster(boolean b)</pre> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="addTriggerFactory(com.amazon.carbonado.TriggerFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTriggerFactory</h4> +<pre>boolean addTriggerFactory(<a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</pre> +<div class="block">Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports. The + primary purpose of this method is to allow decorator repositories the + opportunity to register custom persistence code for each Storable.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if TriggerFactory was added, false if TriggerFactory was + not added because an equal TriggerFactory is already registered</dd></dl> +</li> +</ul> +<a name="removeTriggerFactory(com.amazon.carbonado.TriggerFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeTriggerFactory</h4> +<pre>boolean removeTriggerFactory(<a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</pre> +<div class="block">Remove a TriggerFactory which was added earlier.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if TriggerFactory instance was removed, false if not added</dd></dl> +</li> +</ul> +<a name="getTriggerFactories()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTriggerFactories</h4> +<pre>java.lang.Iterable<<a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> getTriggerFactories()</pre> +<div class="block">Returns all the TriggerFactories which were added.</div> +</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/RepositoryBuilder.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/Repository.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/RepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="RepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/RepositoryException.html b/apidocs/com/amazon/carbonado/RepositoryException.html new file mode 100644 index 0000000..c56e4cd --- /dev/null +++ b/apidocs/com/amazon/carbonado/RepositoryException.html @@ -0,0 +1,499 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>RepositoryException (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="RepositoryException (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/RepositoryException.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/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/RepositoryException.html" target="_top">Frames</a></li> +<li><a href="RepositoryException.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><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</div> +<h2 title="Class RepositoryException" class="title">Class RepositoryException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.RepositoryException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, <a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RepositoryException</span> +extends java.lang.Exception</pre> +<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>. + + <p>Some repository exceptions are the result of an optimistic lock failure + or deadlock. One resolution strategy is to exit all transactions and try the + operation again, after waiting some bounded random amount of time. As a + convenience, this class provides a mechanism to support such a backoff + strategy. For example: + + <pre> + // Retry at most three more times + for (int retryCount = 3;;) { + try { + ... + myObject.load(); + ... + myObject.update(); + break; + } catch (OptimisticLockException e) { + // Wait up to one second before retrying + retryCount = e.backoff(e, retryCount, 1000); + } + } + </pre> + + If the retry count is zero (or less) when backoff is called, then the + original exception is rethrown, indicating retry failure.</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="../../../serialized-form.html#com.amazon.carbonado.RepositoryException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/RepositoryException.html#RepositoryException()">RepositoryException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#RepositoryException(java.lang.String)">RepositoryException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#RepositoryException(java.lang.String, java.lang.Throwable)">RepositoryException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#RepositoryException(java.lang.Throwable)">RepositoryException</a></strong>(java.lang.Throwable cause)</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>static <E extends java.lang.Throwable> <br>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a></strong>(E e, + int retryCount, + int milliseconds)</code> +<div class="block">One strategy for resolving an optimistic lock failure is to try the + operation again, after waiting some bounded random amount of time.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Throwable</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a></strong>()</code> +<div class="block">Recursively calls getCause, until the root cause is found.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a></strong>()</code> +<div class="block">Converts RepositoryException into an appropriate FetchException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a></strong>(java.lang.String message)</code> +<div class="block">Converts RepositoryException into an appropriate FetchException, prepending + the specified message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a></strong>()</code> +<div class="block">Converts RepositoryException into an appropriate PersistException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></strong>(java.lang.String message)</code> +<div class="block">Converts RepositoryException into an appropriate PersistException, prepending + the specified message.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="RepositoryException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RepositoryException</h4> +<pre>public RepositoryException()</pre> +</li> +</ul> +<a name="RepositoryException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RepositoryException</h4> +<pre>public RepositoryException(java.lang.String message)</pre> +</li> +</ul> +<a name="RepositoryException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RepositoryException</h4> +<pre>public RepositoryException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="RepositoryException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RepositoryException</h4> +<pre>public RepositoryException(java.lang.Throwable cause)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="backoff(java.lang.Throwable,int,int)"> +<!-- --> +</a><a name="backoff(E, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>backoff</h4> +<pre>public static <E extends java.lang.Throwable> int backoff(E e, + int retryCount, + int milliseconds) + throws E extends java.lang.Throwable</pre> +<div class="block">One strategy for resolving an optimistic lock failure is to try the + operation again, after waiting some bounded random amount of time. This + method is provided as a convenience, to support such a random wait. + <p> + A retry count is required as well, which is decremented and returned by + this method. If the retry count is zero (or less) when this method is + called, then this exception is thrown again, indicating retry failure.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>retryCount</code> - current retry count, if zero, throw this exception again</dd><dd><code>milliseconds</code> - upper bound on the random amount of time to wait</dd> +<dt><span class="strong">Returns:</span></dt><dd>retryCount minus one</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>E</code> - if retry count is zero</dd> +<dd><code>E extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="getRootCause()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRootCause</h4> +<pre>public java.lang.Throwable getRootCause()</pre> +<div class="block">Recursively calls getCause, until the root cause is found. Returns this + if no root cause.</div> +</li> +</ul> +<a name="toPersistException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toPersistException</h4> +<pre>public final <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> toPersistException()</pre> +<div class="block">Converts RepositoryException into an appropriate PersistException.</div> +</li> +</ul> +<a name="toPersistException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toPersistException</h4> +<pre>public final <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> toPersistException(java.lang.String message)</pre> +<div class="block">Converts RepositoryException into an appropriate PersistException, prepending + the specified message. If message is null, original exception message is + preserved.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - message to prepend, which may be null</dd></dl> +</li> +</ul> +<a name="toFetchException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toFetchException</h4> +<pre>public final <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> toFetchException()</pre> +<div class="block">Converts RepositoryException into an appropriate FetchException.</div> +</li> +</ul> +<a name="toFetchException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toFetchException</h4> +<pre>public final <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> toFetchException(java.lang.String message)</pre> +<div class="block">Converts RepositoryException into an appropriate FetchException, prepending + the specified message. If message is null, original exception message is + preserved.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - message to prepend, which may be null</dd></dl> +</li> +</ul> +<a name="makePersistException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>makePersistException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> makePersistException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</dd></dl> +</li> +</ul> +<a name="makeFetchException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makeFetchException</h4> +<pre>protected <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> makeFetchException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - exception message, which may be null</dd><dd><code>cause</code> - non-null cause</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/RepositoryException.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/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/RepositoryException.html" target="_top">Frames</a></li> +<li><a href="RepositoryException.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><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> diff --git a/apidocs/com/amazon/carbonado/Sequence.html b/apidocs/com/amazon/carbonado/Sequence.html new file mode 100644 index 0000000..4d96094 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Sequence.html @@ -0,0 +1,224 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Sequence (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="Sequence (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/Sequence.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/RepositoryException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Sequence.html" target="_top">Frames</a></li> +<li><a href="Sequence.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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</div> +<h2 title="Annotation Type Sequence" class="title">Annotation Type Sequence</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +public @interface <span class="strong">Sequence</span></pre> +<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. Support for sequences is repository dependent, + and if not supported, a <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado"><code>PersistException</code></a> is thrown when trying to + insert. Explicitly specifying a value bypasses the sequence altogether. + + <p>Example:<pre> + @PrimaryKey("userInfoID") + public interface UserInfo extends Storable<UserInfo> { + <b>@Sequence("USER_ID_SEQ")</b> + long getUserInfoID(); + void setUserInfoID(long id); + + ... + } + </pre></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/Automatic.html" title="annotation in com.amazon.carbonado"><code>Automatic</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Sequence.html#value()">value</a></strong></code> +<div class="block">Name of the sequence used by the storage layer.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="value()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>value</h4> +<pre>public abstract java.lang.String value</pre> +<div class="block">Name of the sequence used by the storage layer.</div> +</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/Sequence.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/RepositoryException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Sequence.html" target="_top">Frames</a></li> +<li><a href="Sequence.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="#annotation_type_required_element_summary">Required</a> | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/Storable.html b/apidocs/com/amazon/carbonado/Storable.html new file mode 100644 index 0000000..d6bd6ba --- /dev/null +++ b/apidocs/com/amazon/carbonado/Storable.html @@ -0,0 +1,1116 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Storable (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="Storable (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/Storable.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/Sequence.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Storable.html" target="_top">Frames</a></li> +<li><a href="Storable.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</div> +<h2 title="Interface Storable" class="title">Interface Storable<S extends Storable<S>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a>, <a href="../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a>, <a href="../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a>, <a href="../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a>, <a href="../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a>, <a href="../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a>, <a href="../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a>, <a href="../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Storable<S extends Storable<S>></span></pre> +<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>. User defined storables must + either extend or implement this interface via an interface or abstract + class. Abstract bean properties defined in the storable are persisted into + the repository. At least one property must be annotated as the <a href="../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><code>PrimaryKey</code></a>. At most one property may be annotated as being the <a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>Version</code></a> property. + + <p>Storable instances are mutable, but they must be thread-safe. Although + race conditions are possible if multiple threads are mutating the Storable, + the Storable instance will not get into a corrupt state.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Don Schneider</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a>, +<a href="../../../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado"><code>Indexes</code></a>, +<a href="../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a>, +<a href="../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><code>Nullable</code></a>, +<a href="../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><code>PrimaryKey</code></a>, +<a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>Version</code></a></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><a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#copy()">copy</a></strong>()</code> +<div class="block">Returns an exact shallow copy of this object, including the state.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties</a></strong>(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</code> +<div class="block">Copies all supported properties, skipping any that are uninitialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties</a></strong>(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</code> +<div class="block">Copies all supported non-primary key properties which are + dirty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties</a></strong>(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</code> +<div class="block">Copies all supported primary key properties, skipping any that are + uninitialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties</a></strong>(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</code> +<div class="block">Copies all supported non-primary key properties which are unequal, + skipping any that are uninitialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty</a></strong>(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</code> +<div class="block">Copies the optional version property, unless it is uninitialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#delete()">delete</a></strong>()</code> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys</a></strong>(java.lang.Object obj)</code> +<div class="block">True if the supported properties which participate in the primary key + are equal.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties</a></strong>(java.lang.Object obj)</code> +<div class="block">True if all supported properties for this object are equal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> +<div class="block">True if all properties and fields are equal, but ignoring the state.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue</a></strong>(java.lang.String propertyName)</code> +<div class="block">Returns a Storable property value by name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties</a></strong>()</code> +<div class="block">Returns true if any non-primary key properties in this object are + dirty.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#insert()">insert</a></strong>()</code> +<div class="block">Inserts a new persistent value for this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean</a></strong>(java.lang.String propertyName)</code> +<div class="block">Returns true if the given property of this Storable is clean.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty</a></strong>(java.lang.String propertyName)</code> +<div class="block">Returns true if the given property of this Storable has been set, but no + load or store operation has been performed yet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported</a></strong>(java.lang.String propertyName)</code> +<div class="block">Returns true if the given property exists and is supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized</a></strong>(java.lang.String propertyName)</code> +<div class="block">Returns true if the given property of this Storable has never been + loaded or set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#load()">load</a></strong>()</code> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean</a></strong>()</code> +<div class="block">Marks all properties as clean, including uninitialized properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty</a></strong>()</code> +<div class="block">Marks all properties as dirty, including uninitialized properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean</a></strong>()</code> +<div class="block">Marks all dirty properties as clean.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty</a></strong>()</code> +<div class="block">Marks all clean properties as dirty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#prepare()">prepare</a></strong>()</code> +<div class="block">Prepares a new object for loading, inserting, updating, or deleting.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Object></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap</a></strong>()</code> +<div class="block">Returns a fixed-size map view of this Storable's properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a></strong>(java.io.InputStream in)</code> +<div class="block">Restores property values and states as encoded by <a href="../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)"><code>writeTo(java.io.OutputStream)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue</a></strong>(java.lang.String propertyName, + java.lang.Object value)</code> +<div class="block">Sets a Storable property value by name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#storableType()">storableType</a></strong>()</code> +<div class="block">Returns the class or interface from which this storable was + generated.</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/Storable.html#toString()">toString</a></strong>()</code> +<div class="block">Returns a string for debugging purposes that contains all supported + property names and values for this object.</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/Storable.html#toStringKeyOnly()">toStringKeyOnly</a></strong>()</code> +<div class="block">Returns a string for debugging purposes that contains supported key + property names and values for this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a></strong>()</code> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a></strong>()</code> +<div class="block">Inserts a new persistent value for this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a></strong>()</code> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a></strong>()</code> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#update()">update</a></strong>()</code> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</a></strong>(java.io.OutputStream out)</code> +<div class="block">Serializes property values and states for temporary storage or for + network transfer.</div> +</td> +</tr> +</table> +</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="load()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>load</h4> +<pre>void load() + throws <a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a>, + <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key. All properties of a key must be initialized for it to be + chosen. The primary key is examined first, and if not fully initialized, + alternate keys are examined in turn. + + <p>If load is successful, altering the primary key is no longer allowed + unless a call to delete succeeds. Attempting to alter the primary key in + this state results in an <code>IllegalStateException</code>. Alternate keys + may always be modified, however. + + <p>Note: This method differs from <a href="../../../com/amazon/carbonado/Storable.html#tryLoad()"><code>tryLoad()</code></a> only in that it + throws an exception if no matching record was found, instead of returning + false. This may indicate that the underlying record was deleted between + a load and reload. When a FetchNoneException is thrown, this object's + state will be the same as if the delete method was called on it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if the state of this instance suggests + that any primary keys are unspecified</dd></dl> +</li> +</ul> +<a name="tryLoad()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryLoad</h4> +<pre>boolean tryLoad() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key. All properties of a key must be initialized for it to be + chosen. The primary key is examined first, and if not fully initialized, + alternate keys are examined in turn. + + <p>If load is successful, altering the primary key is no longer allowed + unless a call to delete succeeds. Attempting to alter the primary key in + this state results in an <code>IllegalStateException</code>. Alternate keys + may always be modified, however. + + <p>Note: This method differs from <a href="../../../com/amazon/carbonado/Storable.html#load()"><code>load()</code></a> only in that it returns + false if no matching record was found, instead of throwing an exception. + This may indicate that the underlying record was deleted between a load + and reload. When false is returned, this object's state will be the same + as if the delete method was called on it.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if found and loaded, false otherwise</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if the state of this instance suggests + that any primary keys are unspecified</dd></dl> +</li> +</ul> +<a name="insert()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>insert</h4> +<pre>void insert() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Inserts a new persistent value for this object. If successful, altering + the primary key is no longer allowed unless a call to delete succeeds. + Attempting to alter the primary key in this state results in an <code>IllegalStateException</code>. Alternate keys may always be modified, however. + + <p>Insert requires that all primary key properties be specified. If not, + an <code>IllegalStateException</code> is thrown. Also, repository + implementations usually require that properties which are not <a href="../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><code>Nullable</code></a> also be specified. Otherwise, a <a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado"><code>ConstraintException</code></a> + may be thrown. + + <p>Note: This method differs from <a href="../../../com/amazon/carbonado/Storable.html#tryInsert()"><code>tryInsert()</code></a> only in that it may + throw a UniqueConstraintException, instead of returning false.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></code> - if it is absolutely known that a key + of inserted object matches an existing one</dd> +<dd><code><a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></code> - if any required properties are unspecified</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if the state of this instance suggests + that any primary keys are unspecified</dd></dl> +</li> +</ul> +<a name="tryInsert()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryInsert</h4> +<pre>boolean tryInsert() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Inserts a new persistent value for this object. If successful, altering + the primary key is no longer allowed unless a call to delete succeeds. + Attempting to alter the primary key in this state results in an <code>IllegalStateException</code>. Alternate keys may always be modified, however. + + <p>Insert requires that all primary key properties be specified. If not, + an <code>IllegalStateException</code> is thrown. Also, repository + implementations usually require that properties which are not <a href="../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><code>Nullable</code></a> also be specified. Otherwise, a <a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado"><code>ConstraintException</code></a> + may be thrown. + + <p>Note: This method differs from <a href="../../../com/amazon/carbonado/Storable.html#insert()"><code>insert()</code></a> only in that it + returns false, instead of throwing a UniqueConstraintException.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>false if it is absolutely known that a key of inserted object + matches an existing one</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></code> - if any required properties are unspecified</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if the state of this instance suggests + that any primary keys are unspecified</dd></dl> +</li> +</ul> +<a name="update()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>update</h4> +<pre>void update() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not. If successful, altering the + primary key is no longer allowed unless a call to delete succeeds. + Attempting to alter the primary key in this state results in an <code>IllegalStateException</code>. Alternate keys may always be modified, however. + + <p>If this object has a <a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> property defined, then + the update logic is a bit more strict. Updates of any storable require + that the primary keys be specified; if a version is present, the version + must be specified as well. If any of the primary key or version + properties are unspecified, an <code>IllegalStateException</code> will be + thrown; if they are fully specified and the version doesn't match the + current record, an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> is thrown. + + <p>Not all properties need to be set on this object when calling + update. Setting a subset results in a partial update. After a successful + update, all properties are set to the actual values in the storage + layer. Put another way, the object is automatically reloaded after a + successful update. + + <p>If PersistNoneException is thrown, this indicates that the underlying + record was deleted. When this happens, this object's state will be the + same as if the delete method was called on it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if record is missing and no update occurred</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd> +<dd><code><a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></code> - if a version property exists and the + optimistic lock failed</dd> +<dd><code>java.lang.IllegalStateException</code> - if the state of this instance suggests + that any primary keys are unspecified, or if a version property is unspecified</dd></dl> +</li> +</ul> +<a name="tryUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryUpdate</h4> +<pre>boolean tryUpdate() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not. If successful, altering the + primary key is no longer allowed unless a call to delete succeeds. + Attempting to alter the primary key in this state results in an <code>IllegalStateException</code>. Alternate keys may always be modified, however. + + <p>If this object has a <a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> property defined, then + the update logic is a bit more strict. Updates of any storable require + that the primary keys be specified; if a version is present, the version + must be specified as well. If any of the primary key or version + properties are unspecified, an <code>IllegalStateException</code> will be + thrown; if they are fully specified and the version doesn't match the + current record, an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> is thrown. + + <p>Not all properties need to be set on this object when calling + update. Setting a subset results in a partial update. After a successful + update, all properties are set to the actual values in the storage + layer. Put another way, the object is automatically reloaded after a + successful update. + + <p>A return value of false indicates that the underlying record was + deleted. When this happens, this object's state will be the same as if + the delete method was called on it.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if record likely exists and was updated, or false if record + absolutely no longer exists and no update occurred</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> - if storage layer throws an exception</dd> +<dd><code><a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></code> - if a version property exists and the + optimistic lock failed</dd> +<dd><code>java.lang.IllegalStateException</code> - if the state of this instance suggests + that any primary keys are unspecified, or if a version property is unspecified</dd></dl> +</li> +</ul> +<a name="delete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>void delete() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not. + Calling delete does not prevent this object from being used again. All + property values are still valid, including the primary key. Once + deleted, the insert operation is permitted again. + + <p>Note: This method differs from <a href="../../../com/amazon/carbonado/Storable.html#tryDelete()"><code>tryDelete()</code></a> only in that it may + throw a PersistNoneException, instead of returning false.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if record is missing and nothing was + deleted</dd> +<dd><code><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if the state of this instance suggests + that any primary keys are unspecified</dd></dl> +</li> +</ul> +<a name="tryDelete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDelete</h4> +<pre>boolean tryDelete() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not. + Calling delete does not prevent this object from being used again. All + property values are still valid, including the primary key. Once + deleted, the insert operation is permitted again. + + <p>Note: This method differs from <a href="../../../com/amazon/carbonado/Storable.html#delete()"><code>delete()</code></a> only in that it + returns false, instead of throwing a PersistNoneException.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if record likely existed and was deleted, or false if record + absolutely no longer exists and no delete was necessary</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalStateException</code> - if the state of this instance suggests + that any primary keys are unspecified</dd></dl> +</li> +</ul> +<a name="storableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>storableType</h4> +<pre>java.lang.Class<<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a>> storableType()</pre> +<div class="block">Returns the class or interface from which this storable was + generated. This represents the data class for the storable. + + <p><i>Design note: the name "getStorableType" is avoided, so as not to + conflict with a user defined property of "storableType"</i></div> +</li> +</ul> +<a name="copyAllProperties(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyAllProperties(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyAllProperties</h4> +<pre>void copyAllProperties(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</pre> +<div class="block">Copies all supported properties, skipping any that are uninitialized. + Specifically, calls "target.set<property>" for all supported + properties in this storable, passing the value of the property from this + object. Unsupported <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> properties in this + or the target are not copied.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - storable on which to call set<property> methods</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any primary key properties of target + cannot be altered</dd></dl> +</li> +</ul> +<a name="copyPrimaryKeyProperties(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyPrimaryKeyProperties(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyPrimaryKeyProperties</h4> +<pre>void copyPrimaryKeyProperties(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</pre> +<div class="block">Copies all supported primary key properties, skipping any that are + uninitialized. Specifically, calls "target.set<property>" for all + supported properties which participate in the primary key, passing the + value of the property from this object. Unsupported <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> properties in this or the target are not copied.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - storable on which to call set<property> methods</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any primary key properties of target + cannot be altered</dd></dl> +</li> +</ul> +<a name="copyVersionProperty(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyVersionProperty(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyVersionProperty</h4> +<pre>void copyVersionProperty(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</pre> +<div class="block">Copies the optional version property, unless it is uninitialized. + Specifically, calls "target.set<property>" for the version + property (if supported), passing the value of the property from this + object. If no version property is defined, then this method does + nothing. Unsupported <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> properties in this + or the target are not copied.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - storable on which to call set<property> method</dd></dl> +</li> +</ul> +<a name="copyUnequalProperties(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyUnequalProperties(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyUnequalProperties</h4> +<pre>void copyUnequalProperties(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</pre> +<div class="block">Copies all supported non-primary key properties which are unequal, + skipping any that are uninitialized. Specifically, calls + "target.get<property>", and if the value thus retrieved differs + from the local value, "target.set<property>" is called for that + property. Unsupported <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> properties in this + or the target are not copied.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - storable on which to call set<property> methods</dd></dl> +</li> +</ul> +<a name="copyDirtyProperties(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyDirtyProperties(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyDirtyProperties</h4> +<pre>void copyDirtyProperties(<a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> target)</pre> +<div class="block">Copies all supported non-primary key properties which are + dirty. Specifically, calls "target.set<property>" for any + non-primary key property which is dirty, passing the value of the + property from this object. A property is considered dirty when set + before a load or persist operation is called. Unsupported <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> properties in this or the target are not + copied.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - storable on which to call set<property> methods</dd></dl> +</li> +</ul> +<a name="hasDirtyProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasDirtyProperties</h4> +<pre>boolean hasDirtyProperties()</pre> +<div class="block">Returns true if any non-primary key properties in this object are + dirty. A property is considered dirty when set before a load or persist + operation is called. A property becomes clean after a successful load, + insert, or update operation.</div> +</li> +</ul> +<a name="markPropertiesClean()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>markPropertiesClean</h4> +<pre>void markPropertiesClean()</pre> +<div class="block">Marks all dirty properties as clean. Uninitialized properties remain so. + As a side-effect, initialized primary keys may no longer be altered.</div> +</li> +</ul> +<a name="markAllPropertiesClean()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>markAllPropertiesClean</h4> +<pre>void markAllPropertiesClean()</pre> +<div class="block">Marks all properties as clean, including uninitialized properties. + As a side-effect, primary keys may no longer be altered.</div> +</li> +</ul> +<a name="markPropertiesDirty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>markPropertiesDirty</h4> +<pre>void markPropertiesDirty()</pre> +<div class="block">Marks all clean properties as dirty. Uninitialized properties remain so. + As a side-effect, primary keys can be altered.</div> +</li> +</ul> +<a name="markAllPropertiesDirty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>markAllPropertiesDirty</h4> +<pre>void markAllPropertiesDirty()</pre> +<div class="block">Marks all properties as dirty, including uninitialized properties. + As a side-effect, primary keys can be altered.</div> +</li> +</ul> +<a name="isPropertyUninitialized(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPropertyUninitialized</h4> +<pre>boolean isPropertyUninitialized(java.lang.String propertyName)</pre> +<div class="block">Returns true if the given property of this Storable has never been + loaded or set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to interrogate</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is unknown, is a join or is derived</dd></dl> +</li> +</ul> +<a name="isPropertyDirty(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPropertyDirty</h4> +<pre>boolean isPropertyDirty(java.lang.String propertyName)</pre> +<div class="block">Returns true if the given property of this Storable has been set, but no + load or store operation has been performed yet.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to interrogate</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is unknown, is a join or is derived</dd></dl> +</li> +</ul> +<a name="isPropertyClean(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPropertyClean</h4> +<pre>boolean isPropertyClean(java.lang.String propertyName)</pre> +<div class="block">Returns true if the given property of this Storable is clean. All + properties are clean after a successful load or store operation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to interrogate</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is unknown, is a join or is derived</dd></dl> +</li> +</ul> +<a name="isPropertySupported(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPropertySupported</h4> +<pre>boolean isPropertySupported(java.lang.String propertyName)</pre> +<div class="block">Returns true if the given property exists and is supported. If a + Storable has an <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a> property which is not supported by + the repository, then this method returns false.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to check</dd></dl> +</li> +</ul> +<a name="getPropertyValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyValue</h4> +<pre>java.lang.Object getPropertyValue(java.lang.String propertyName)</pre> +<div class="block">Returns a Storable property value by name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to get value of</dd> +<dt><span class="strong">Returns:</span></dt><dd>property value, which is boxed if property type is primitive</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is unknown or if accessor + method declares throwing any checked exceptions</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if property is independent but unsupported</dd> +<dd><code>java.lang.NullPointerException</code> - if property name is null</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setPropertyValue(java.lang.String, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertyValue</h4> +<pre>void setPropertyValue(java.lang.String propertyName, + java.lang.Object value)</pre> +<div class="block">Sets a Storable property value by name. Call insert or update to persist + the change.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to set value to</dd><dd><code>value</code> - new value for property</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is unknown, or if value is + unsupported due to a constraint, or if mutator method declares throwing + any checked exceptions</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if property is independent but unsupported</dd> +<dd><code>java.lang.ClassCastException</code> - if value is of wrong type</dd> +<dd><code>java.lang.NullPointerException</code> - if property name is null or if primitive + value is required but value is null</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="propertyMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>propertyMap</h4> +<pre>java.util.Map<java.lang.String,java.lang.Object> propertyMap()</pre> +<div class="block">Returns a fixed-size map view of this Storable's properties. Properties + which declare throwing any checked exceptions are excluded from the + map. Removing and adding of map entries is unsupported.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>map of property name to property value; primitive property + values are boxed</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="copy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copy</h4> +<pre><a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> copy()</pre> +<div class="block">Returns an exact shallow copy of this object, including the state.</div> +</li> +</ul> +<a name="prepare()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre><a href="../../../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> prepare()</pre> +<div class="block">Prepares a new object for loading, inserting, updating, or deleting.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Storage.html#prepare()"><code>Storage.prepare()</code></a></dd></dl> +</li> +</ul> +<a name="writeTo(java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeTo</h4> +<pre>void writeTo(java.io.OutputStream out) + throws java.io.IOException, + <a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Serializes property values and states for temporary storage or for + network transfer. Call <a href="../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)"><code>readFrom(java.io.InputStream)</code></a> to restore. Derived and join + properties are not serialized. + + <p>The encoding used by this method is much simpler than what is + provided by standard object serialization. It does not encode class info + or property names, which is why it is not suitable for long term + storage.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if exception from stream</dd> +<dd><code><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if Storable cannot be serialized</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="readFrom(java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFrom</h4> +<pre>void readFrom(java.io.InputStream in) + throws java.io.IOException, + <a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Restores property values and states as encoded by <a href="../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)"><code>writeTo(java.io.OutputStream)</code></a>. + Derived properties are not directly modified, but all other properties + not restored are reset to their initial state.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if exception from stream</dd> +<dd><code><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if Storable cannot be serialized</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>boolean equals(java.lang.Object obj)</pre> +<div class="block">True if all properties and fields are equal, but ignoring the state.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - object to compare to for equality</dd></dl> +</li> +</ul> +<a name="equalPrimaryKeys(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equalPrimaryKeys</h4> +<pre>boolean equalPrimaryKeys(java.lang.Object obj)</pre> +<div class="block">True if the supported properties which participate in the primary key + are equal. This is useful to cheaply investigate if two storables refer + to the same entity, regardless of the state of object (specifically the + non-key properties). Unsupported <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> + properties in this or the target are not compared.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - object to compare to for equality</dd></dl> +</li> +</ul> +<a name="equalProperties(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equalProperties</h4> +<pre>boolean equalProperties(java.lang.Object obj)</pre> +<div class="block">True if all supported properties for this object are equal. Unsupported + <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> properties in this or the target are not + compared.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - object to compare to for equality</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>java.lang.String toString()</pre> +<div class="block">Returns a string for debugging purposes that contains all supported + property names and values for this object. Uninitialized and unsupported + <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> properties are not included.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toStringKeyOnly()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toStringKeyOnly</h4> +<pre>java.lang.String toStringKeyOnly()</pre> +<div class="block">Returns a string for debugging purposes that contains supported key + property names and values for this object. Uninitialized and unsupported + <a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> properties are not included.</div> +</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/Storable.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/Sequence.html" title="annotation in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Storable.html" target="_top">Frames</a></li> +<li><a href="Storable.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> diff --git a/apidocs/com/amazon/carbonado/Storage.html b/apidocs/com/amazon/carbonado/Storage.html new file mode 100644 index 0000000..96edf4c --- /dev/null +++ b/apidocs/com/amazon/carbonado/Storage.html @@ -0,0 +1,415 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Storage (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="Storage (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/Storage.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/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Storage.html" target="_top">Frames</a></li> +<li><a href="Storage.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</div> +<h2 title="Interface Storage" class="title">Interface Storage<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"> +<hr> +<br> +<pre>public interface <span class="strong">Storage<S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<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>. + + <p>Storage instances are mutable, but they are thread-safe.</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storage.html#addTrigger(com.amazon.carbonado.Trigger)">addTrigger</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> trigger)</code> +<div class="block">Register a trigger which will be called for overridden methods in the given + trigger implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storage.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storage.html#prepare()">prepare</a></strong>()</code> +<div class="block">Prepares a new object for loading, inserting, updating, or deleting.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storage.html#query()">query</a></strong>()</code> +<div class="block">Query for all Storable instances in this Storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storage.html#query(com.amazon.carbonado.filter.Filter)">query</a></strong>(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> filter)</code> +<div class="block">Query for Storable instances against an explicitly constructed filter + object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)">query</a></strong>(java.lang.String filter)</code> +<div class="block">Query for Storable instances against a filter expression.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storage.html#removeTrigger(com.amazon.carbonado.Trigger)">removeTrigger</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> trigger)</code> +<div class="block">Remove a trigger which was registered earlier.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Storage.html#truncate()">truncate</a></strong>()</code> +<div class="block">Attempts to quickly delete all Storables instances in this + Storage.</div> +</td> +</tr> +</table> +</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> getStorableType()</pre> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</li> +</ul> +<a name="prepare()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre><a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a> prepare()</pre> +<div class="block">Prepares a new object for loading, inserting, updating, or deleting.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a new data access object</dd></dl> +</li> +</ul> +<a name="query()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> query() + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Query for all Storable instances in this Storage.</div> +<dl><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> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>query(String)</code></a></dd></dl> +</li> +</ul> +<a name="query(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> query(java.lang.String filter) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Query for Storable instances against a filter expression. A filter tests + if property values match against specific values specified by '?' + placeholders. The simplest filter compares just one property, like + <code>"ID = ?"</code>. Filters can also contain several kinds of relational + operators, boolean logic operators, sub-properties, and parentheses. A + more complex example might be <code>"income < ? | (name = ? & address.zipCode != ?)"</code>. + <p> + When querying for a single Storable instance by its primary key, it is + generally more efficient to call <a href="../../../com/amazon/carbonado/Storage.html#prepare()"><code>prepare()</code></a>, set primary key + properties, and then call <a href="../../../com/amazon/carbonado/Storable.html#load()"><code>Storable.load()</code></a>. For example, consider + an object with a primary key consisting only of the property "ID". It + can be queried as: + <pre> + Storage<UserInfo> users; + UserInfo user = users.query("ID = ?").with(123456).loadOne(); + </pre> + The above code will likely open a Cursor in order to verify that just + one object was loaded. Instead, do this: + <pre> + Storage<UserInfo> users; + UserInfo user = users.prepare(); + user.setID(123456); + user.load(); + </pre> + The complete syntax for query filters follows. Note that: + <ul> + <li> literals are not allowed + <li> logical 'and' operator has precedence over 'or' + <li> logical 'not' operator has precedence over 'and' + <li> '?' placeholders can only appear after relational operators + </ul> + <pre> + Filter = OrFilter + OrFilter = AndFilter { "|" AndFilter } + AndFilter = NotFilter { "&" NotFilter } + NotFilter = [ "!" ] EntityFilter + EntityFilter = PropertyFilter + | ChainedFilter + | "(" Filter ")" + PropertyFilter = ChainedProperty RelOp "?" + RelOp = "=" | "!=" | "<" | ">=" | ">" | "<=" + ChainedFilter = ChainedProperty "(" [ Filter ] ")" + ChainedProperty = Identifier + | InnerJoin "." ChainedProperty + | OuterJoin "." ChainedProperty + InnerJoin = Identifier + OuterJoin = "(" Identifier ")" + </pre></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter expression</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></code> - if expression is malformed</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre><a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> query(<a href="../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> filter) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Query for Storable instances against an explicitly constructed filter + object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</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> - if storage layer throws an exception</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code>java.lang.UnsupportedOperationException</code> - if given filter is unsupported by repository</dd></dl> +</li> +</ul> +<a name="truncate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>truncate</h4> +<pre>void truncate() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Attempts to quickly delete all Storables instances in this + Storage. Support for transactional truncation is not guaranteed. + + <p>If this Storage has any registered triggers which act on deletes, all + Storables are deleted via <code>query().deleteAll()</code> instead to ensure + these triggers get run.</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></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="addTrigger(com.amazon.carbonado.Trigger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTrigger</h4> +<pre>boolean addTrigger(<a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> trigger)</pre> +<div class="block">Register a trigger which will be called for overridden methods in the given + trigger implementation. The newly added trigger is invoked before and + after all other triggers. In other words, it is added at the outermost + nesting level.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if trigger was added, false if trigger was not added + because an equal trigger is already registered</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if trigger is null</dd></dl> +</li> +</ul> +<a name="removeTrigger(com.amazon.carbonado.Trigger)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>removeTrigger</h4> +<pre>boolean removeTrigger(<a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> trigger)</pre> +<div class="block">Remove a trigger which was registered earlier.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if trigger instance was removed, false if not registered</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if trigger is null</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/Storage.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/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Storage.html" target="_top">Frames</a></li> +<li><a href="Storage.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> diff --git a/apidocs/com/amazon/carbonado/SupportException.html b/apidocs/com/amazon/carbonado/SupportException.html new file mode 100644 index 0000000..8743315 --- /dev/null +++ b/apidocs/com/amazon/carbonado/SupportException.html @@ -0,0 +1,311 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>SupportException (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="SupportException (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/SupportException.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/Storage.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/SupportException.html" target="_top">Frames</a></li> +<li><a href="SupportException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class SupportException" class="title">Class SupportException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.SupportException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a>, <a href="../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a>, <a href="../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SupportException</span> +extends <a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<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. Typically this results from + an attempt to get storage for a <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> which is not supported, + or an attempt to configure a repository improperly.</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="../../../serialized-form.html#com.amazon.carbonado.SupportException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/SupportException.html#SupportException()">SupportException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/SupportException.html#SupportException(java.lang.String)">SupportException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/SupportException.html#SupportException(java.lang.String, java.lang.Throwable)">SupportException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/SupportException.html#SupportException(java.lang.Throwable)">SupportException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="SupportException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SupportException</h4> +<pre>public SupportException()</pre> +</li> +</ul> +<a name="SupportException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SupportException</h4> +<pre>public SupportException(java.lang.String message)</pre> +</li> +</ul> +<a name="SupportException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SupportException</h4> +<pre>public SupportException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="SupportException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SupportException</h4> +<pre>public SupportException(java.lang.Throwable cause)</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/SupportException.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/Storage.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/SupportException.html" target="_top">Frames</a></li> +<li><a href="SupportException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/Transaction.html b/apidocs/com/amazon/carbonado/Transaction.html new file mode 100644 index 0000000..90fa943 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Transaction.html @@ -0,0 +1,446 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Transaction (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="Transaction (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/Transaction.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/SupportException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Transaction.html" target="_top">Frames</a></li> +<li><a href="Transaction.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</div> +<h2 title="Interface Transaction" class="title">Interface Transaction</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Transaction</span></pre> +<div class="block">Transactions define atomic operations which can be committed or aborted as a + unit. Transactions are entered by calling <a href="../../../com/amazon/carbonado/Repository.html#enterTransaction()"><code>Repository.enterTransaction()</code></a>. + Transactions are thread-local, and so no special action needs to be taken to + bind operations to them. Cursors which are opened in the scope of a + transaction are automatically closed when the transaction is committed or + aborted. + + <p>Transactions do not exit when they are committed. The transaction is + still valid after a commit, but new operations are grouped into a separate + atomic unit. The exit method <em>must</em> be invoked on every + transaction. The following pattern is recommended: + + <pre> + Transaction txn = repository.enterTransaction(); + try { + // Make updates to storage layer + ... + + // Commit the changes up to this point + txn.commit(); + + // Optionally make more updates + ... + + // Commit remaining changes + txn.commit(); + } finally { + // Ensure transaction exits, aborting uncommitted changes if an exception was thrown + txn.exit(); + } + </pre> + + <p>Transactions may be nested. Calling commit or abort on an outer + transaction will recursively apply the same operation to all inner + transactions as well. All Cursors contained within are also closed. + + <p>Transaction instances are mutable, but they are thread-safe.</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/Transaction.html#attach()">attach</a></strong>()</code> +<div class="block">Attaches this transaction to the current thread, if it has been + detached.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#commit()">commit</a></strong>()</code> +<div class="block">If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#detach()">detach</a></strong>()</code> +<div class="block">Detaches this transaction from the current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#exit()">exit</a></strong>()</code> +<div class="block">Closes the current transaction, aborting all changes since the last + commit.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#getIsolationLevel()">getIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of this transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#isForUpdate()">isForUpdate</a></strong>()</code> +<div class="block">Returns true if this transaction is in update mode, which is adjusted by + calling <a href="../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)"><code>setForUpdate(boolean)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#preCommit()">preCommit</a></strong>()</code> +<div class="block">Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)">setDesiredLockTimeout</a></strong>(int timeout, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Specify a desired timeout for aquiring locks within this + transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)">setForUpdate</a></strong>(boolean forUpdate)</code> +<div class="block">Set to true to force all read operations within this transaction to + acquire upgradable or write locks.</div> +</td> +</tr> +</table> +</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="commit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commit</h4> +<pre>void commit() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.</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 storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="exit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exit</h4> +<pre>void exit() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Closes the current transaction, aborting all changes since the last + commit.</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 storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="setForUpdate(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForUpdate</h4> +<pre>void setForUpdate(boolean forUpdate)</pre> +<div class="block">Set to true to force all read operations within this transaction to + acquire upgradable or write locks. This option eliminates deadlocks that + may occur when updating records, except it may increase contention.</div> +</li> +</ul> +<a name="isForUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isForUpdate</h4> +<pre>boolean isForUpdate()</pre> +<div class="block">Returns true if this transaction is in update mode, which is adjusted by + calling <a href="../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)"><code>setForUpdate(boolean)</code></a>.</div> +</li> +</ul> +<a name="setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDesiredLockTimeout</h4> +<pre>void setDesiredLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit)</pre> +<div class="block">Specify a desired timeout for aquiring locks within this + transaction. Calling this method may have have no effect at all, if the + repository does not support this feature. In addition, the lock timeout + might not be alterable if the transaction contains uncommitted data. + + <p>Also, the range of lock timeout values supported might be small. For + example, only a timeout value of zero might be supported. In that case, + the transaction is configured to not wait at all when trying to acquire + locks. Expect immediate timeout exceptions when locks cannot be + granted. + + <p>Nested transactions inherit the desired lock timeout of their + parent. Top transactions always begin with the default lock timeout.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Desired lock timeout. If negative, revert lock timeout to + default value.</dd><dd><code>unit</code> - Time unit for timeout. If null, revert lock timeout to + default value.</dd></dl> +</li> +</ul> +<a name="getIsolationLevel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIsolationLevel</h4> +<pre><a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> getIsolationLevel()</pre> +<div class="block">Returns the isolation level of this transaction.</div> +</li> +</ul> +<a name="detach()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>detach</h4> +<pre>void detach()</pre> +<div class="block">Detaches this transaction from the current thread. It can be attached + later, and to any thread which currently has no thread-local + transaction. + + <p>Detaching a transaction also detaches any parent and nested child + transactions. Attaching any of them achieves the same result as + attaching this transaction.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if transaction is attached to a different + thread</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="attach()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>attach</h4> +<pre>void attach()</pre> +<div class="block">Attaches this transaction to the current thread, if it has been + detached. Attaching a transaction also attaches any parent and nested + child transactions.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if current thread has a different + transaction already attached</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="preCommit()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>preCommit</h4> +<pre>boolean preCommit() + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads. The + commit method must still be called to finish the commit. Most applications + have no use for pre-commit and should only ever call commit. + + <p>The intent of this method is to complete as many operations as + possible leading up to the actual commit. If pre-commit succeeds, then + commit will most likely succeed as well. While in a pre-commit state, the + transaction can still be used by the current thread. Calling pre-commit + again ensures that child transactions and cursors are closed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>false if transaction has exited</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> +</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/Transaction.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/SupportException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Transaction.html" target="_top">Frames</a></li> +<li><a href="Transaction.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> diff --git a/apidocs/com/amazon/carbonado/Trigger.Abort.html b/apidocs/com/amazon/carbonado/Trigger.Abort.html new file mode 100644 index 0000000..b566bf3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Trigger.Abort.html @@ -0,0 +1,291 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Trigger.Abort (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="Trigger.Abort (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/Trigger.Abort.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/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Trigger.Abort.html" target="_top">Frames</a></li> +<li><a href="Trigger.Abort.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</div> +<h2 title="Class Trigger.Abort" class="title">Class Trigger.Abort</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.Trigger.Abort</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a>></dd> +</dl> +<hr> +<br> +<pre>public static final class <span class="strong">Trigger.Abort</span> +extends <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#com.amazon.carbonado.Trigger.Abort">Serialized Form</a></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>java.lang.Throwable</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.Abort.html#fillInStackTrace()">fillInStackTrace</a></strong>()</code> +<div class="block">Override to remove the stack trace.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.Abort.html#withStackTrace()">withStackTrace</a></strong>()</code> +<div class="block">Returns this exception but with a fresh stack trace.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="fillInStackTrace()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fillInStackTrace</h4> +<pre>public java.lang.Throwable fillInStackTrace()</pre> +<div class="block">Override to remove the stack trace.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>fillInStackTrace</code> in class <code>java.lang.Throwable</code></dd> +</dl> +</li> +</ul> +<a name="withStackTrace()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>withStackTrace</h4> +<pre>public <a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a> withStackTrace()</pre> +<div class="block">Returns this exception but with a fresh stack trace. The trace does + not include the original thrower of this exception.</div> +</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/Trigger.Abort.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/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Trigger.Abort.html" target="_top">Frames</a></li> +<li><a href="Trigger.Abort.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> diff --git a/apidocs/com/amazon/carbonado/Trigger.html b/apidocs/com/amazon/carbonado/Trigger.html new file mode 100644 index 0000000..b2946f2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Trigger.html @@ -0,0 +1,971 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Trigger (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="Trigger (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/Trigger.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/Transaction.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Trigger.html" target="_top">Frames</a></li> +<li><a href="Trigger.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</div> +<h2 title="Class Trigger" class="title">Class Trigger<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.Trigger<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a>, <a href="../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">Trigger<S></span> +extends java.lang.Object</pre> +<div class="block">Callback mechanism to allow custom code to run when a storable is + persisted. By default, the methods defined in this class do + nothing. Subclass and override trigger conditions of interest, and then + <a href="../../../com/amazon/carbonado/Storage.html#addTrigger(com.amazon.carbonado.Trigger)"><code>register</code></a> it. Each overridden trigger method is + called in the same transaction scope as the persist operation. Trigger + implementations are encouraged to override the equals method, to prevent + accidental double registration. + + <p>To ensure proper nesting, all "before" events are run in the + <em>opposite</em> order that the trigger was registered. All "after" and + "failed" events are run in the same order that the trigger was registered. + In other words, the last added trigger is at the outermost nesting level. + + <p>Triggers always run within the same transaction as the triggering + operation. The exact isolation level and update mode is outside the + trigger's control. If an explicit isolation level or update mode is + required, create a nested transaction within a trigger method. A trigger's + nested transaction can also be defined to span the entire triggering operation. + To do this, enter the transaction in the "before" method, but return the + transaction object without exiting it. The "after" method is responsible for + exiting the transaction. It extracts (or simply casts) the transaction from + the state object passed into it. When creating spanning transactions like + this, it is critical that the "failed" method be defined to properly exit + the transaction upon failure.</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"> +<!-- ======== 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 class </code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</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/Trigger.html#Trigger()">Trigger</a></strong>()</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>protected <a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()">abortTry</a></strong>()</code> +<div class="block">Call to quickly abort a "try" operation, returning false to the + caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">afterDelete</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">afterInsert</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully inserted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#afterLoad(S)">afterLoad</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called right after a storable has been successfully loaded or + fetched.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully deleted via + tryDelete.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully inserted via + tryInsert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully updated via + tryUpdate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)">beforeDelete</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></strong>(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)">beforeInsert</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></strong>(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">beforeTryDelete</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></strong>(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">beforeTryInsert</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></strong>(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">beforeTryUpdate</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></strong>(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">beforeUpdate</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></strong>(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#failedDelete(S, java.lang.Object)">failedDelete</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an delete operation failed because the record was missing or + an exception was thrown.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#failedInsert(S, java.lang.Object)">failedInsert</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an insert operation failed due to a unique constraint + violation or an exception was thrown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/Trigger.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></strong>(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an update operation failed because the record was missing or + an exception was thrown.</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> +</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="Trigger()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Trigger</h4> +<pre>public Trigger()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="beforeInsert(java.lang.Object)"> +<!-- --> +</a><a name="beforeInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeInsert</h4> +<pre>public java.lang.Object beforeInsert(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be inserted. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterInsert or failedInsert method</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="beforeInsert(com.amazon.carbonado.Transaction,java.lang.Object)"> +<!-- --> +</a><a name="beforeInsert(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeInsert</h4> +<pre>public java.lang.Object beforeInsert(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be inserted. The default implementation + simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)"><code>beforeInsert(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterInsert or failedInsert method</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="beforeTryInsert(java.lang.Object)"> +<!-- --> +</a><a name="beforeTryInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryInsert</h4> +<pre>public java.lang.Object beforeTryInsert(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be inserted via tryInsert. The default + implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)"><code>beforeInsert(Object)</code></a>. Only override + if trigger needs to distinguish between different insert variants. + + <p>Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryInsert or failedInsert method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryInsert(com.amazon.carbonado.Transaction,java.lang.Object)"> +<!-- --> +</a><a name="beforeTryInsert(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryInsert</h4> +<pre>public java.lang.Object beforeTryInsert(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be inserted via tryInsert. The default + implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)"><code>beforeTryInsert(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different insert variants. + + <p>Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryInsert or failedInsert method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterInsert(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterInsert</h4> +<pre>public void afterInsert(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a storable has been successfully inserted. The + default implementation does nothing. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being inserted</dd><dd><code>state</code> - object returned by beforeInsert method</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="afterTryInsert(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterTryInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryInsert</h4> +<pre>public void afterTryInsert(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a storable has been successfully inserted via + tryInsert. The default implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)"><code>afterInsert(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different insert + variants. + + <p>Any exception thrown by this method will cause the tryInsert + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryInsert method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being inserted</dd><dd><code>state</code> - object returned by beforeTryInsert method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedInsert(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedInsert</h4> +<pre>public void failedInsert(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</pre> +<div class="block">Called when an insert operation failed due to a unique constraint + violation or an exception was thrown. The main purpose of this method is + to allow any necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable which failed to be inserted</dd><dd><code>state</code> - object returned by beforeInsert method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeUpdate(java.lang.Object)"> +<!-- --> +</a><a name="beforeUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be updated. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterUpdate or failedUpdate method</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="beforeUpdate(com.amazon.carbonado.Transaction,java.lang.Object)"> +<!-- --> +</a><a name="beforeUpdate(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be updated. The default implementation + simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)"><code>beforeUpdate(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterUpdate or failedUpdate method</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="beforeTryUpdate(java.lang.Object)"> +<!-- --> +</a><a name="beforeTryUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryUpdate</h4> +<pre>public java.lang.Object beforeTryUpdate(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be updated via tryUpdate. The default + implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)"><code>beforeUpdate(Object)</code></a>. Only override + if trigger needs to distinguish between different update variants. + + <p>Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryUpdate or failedUpdate method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryUpdate(com.amazon.carbonado.Transaction,java.lang.Object)"> +<!-- --> +</a><a name="beforeTryUpdate(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryUpdate</h4> +<pre>public java.lang.Object beforeTryUpdate(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be updated via tryUpdate. The default + implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)"><code>beforeTryUpdate(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different update variants. + + <p>Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryUpdate or failedUpdate method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterUpdate</h4> +<pre>public void afterUpdate(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a storable has been successfully updated. The default + implementation does nothing. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being updated</dd><dd><code>state</code> - optional object returned by beforeUpdate method</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="afterTryUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterTryUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryUpdate</h4> +<pre>public void afterTryUpdate(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a storable has been successfully updated via + tryUpdate. The default implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)"><code>afterUpdate(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different update + variants. + + <p>Any exception thrown by this method will cause the tryUpdate + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryUpdate method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being updated</dd><dd><code>state</code> - object returned by beforeTryUpdate method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedUpdate</h4> +<pre>public void failedUpdate(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</pre> +<div class="block">Called when an update operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable which failed to be updated</dd><dd><code>state</code> - optional object returned by beforeUpdate + method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeDelete(java.lang.Object)"> +<!-- --> +</a><a name="beforeDelete(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeDelete</h4> +<pre>public java.lang.Object beforeDelete(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be deleted. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterDelete or failedDelete method</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="beforeDelete(com.amazon.carbonado.Transaction,java.lang.Object)"> +<!-- --> +</a><a name="beforeDelete(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeDelete</h4> +<pre>public java.lang.Object beforeDelete(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be deleted. The default implementation + simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)"><code>beforeDelete(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterDelete or failedDelete method</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="beforeTryDelete(java.lang.Object)"> +<!-- --> +</a><a name="beforeTryDelete(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryDelete</h4> +<pre>public java.lang.Object beforeTryDelete(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be deleted via tryDelete. The default + implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)"><code>beforeDelete(Object)</code></a>. Only override + if trigger needs to distinguish between different delete variants. + + <p>Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryDelete or failedDelete method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryDelete(com.amazon.carbonado.Transaction,java.lang.Object)"> +<!-- --> +</a><a name="beforeTryDelete(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryDelete</h4> +<pre>public java.lang.Object beforeTryDelete(<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a storable is to be deleted via tryDelete. The default + implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)"><code>beforeTryDelete(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different delete variants. + + <p>Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryDelete or failedDelete method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterDelete(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterDelete</h4> +<pre>public void afterDelete(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a storable has been successfully deleted. The default + implementation does nothing. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being deleted</dd><dd><code>state</code> - optional object returned by beforeDelete method</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="afterTryDelete(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterTryDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryDelete</h4> +<pre>public void afterTryDelete(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state) + throws <a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a storable has been successfully deleted via + tryDelete. The default implementation simply calls <a href="../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)"><code>afterDelete(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different delete + variants. + + <p>Any exception thrown by this method will cause the tryDelete + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryDelete method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being deleted</dd><dd><code>state</code> - object returned by beforeTryDelete method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedDelete(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedDelete</h4> +<pre>public void failedDelete(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</pre> +<div class="block">Called when an delete operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable which failed to be deleted</dd><dd><code>state</code> - optional object returned by beforeDelete + method, but it may be null</dd></dl> +</li> +</ul> +<a name="afterLoad(java.lang.Object)"> +<!-- --> +</a><a name="afterLoad(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterLoad</h4> +<pre>public void afterLoad(<a href="../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable) + throws <a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Called right after a storable has been successfully loaded or + fetched. The default implementation does nothing.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - storable after being loaded or fetched</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="abortTry()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>abortTry</h4> +<pre>protected <a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a> abortTry() + throws <a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></pre> +<div class="block">Call to quickly abort a "try" operation, returning false to the + caller. This method should not be called by a non-try trigger method, + since the caller gets thrown an exception with an incomplete stack trace. + + <p>This method never returns normally, but as a convenience, a return + type is defined. The abort exception can be thrown by <code>throw abortTry()</code>, + but the <code>throw</code> keyword is not needed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</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/Trigger.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/Transaction.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Trigger.html" target="_top">Frames</a></li> +<li><a href="Trigger.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> diff --git a/apidocs/com/amazon/carbonado/TriggerFactory.html b/apidocs/com/amazon/carbonado/TriggerFactory.html new file mode 100644 index 0000000..c5511b5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/TriggerFactory.html @@ -0,0 +1,223 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TriggerFactory (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="TriggerFactory (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/TriggerFactory.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/Trigger.Abort.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/TriggerFactory.html" target="_top">Frames</a></li> +<li><a href="TriggerFactory.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</div> +<h2 title="Interface TriggerFactory" class="title">Interface TriggerFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">TriggerFactory</span></pre> +<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> +<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><S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super S></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/TriggerFactory.html#triggerFor(java.lang.Class)">triggerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Return an appropriate trigger for the given type, or null if none.</div> +</td> +</tr> +</table> +</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="triggerFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>triggerFor</h4> +<pre><S extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super S> triggerFor(java.lang.Class<S> type) + throws <a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Return an appropriate trigger for the given type, or null if none. This + method is expected to be called at most once per Storable type. As an + extra safeguard, trigger implementations are encouraged to implement the + equals method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Storable type requesting an automatic trigger</dd> +<dt><span class="strong">Returns:</span></dt><dd>trigger instance or null if not applicable</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/TriggerFactory.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/Trigger.Abort.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/TriggerFactory.html" target="_top">Frames</a></li> +<li><a href="TriggerFactory.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> diff --git a/apidocs/com/amazon/carbonado/UniqueConstraintException.html b/apidocs/com/amazon/carbonado/UniqueConstraintException.html new file mode 100644 index 0000000..9c2c92f --- /dev/null +++ b/apidocs/com/amazon/carbonado/UniqueConstraintException.html @@ -0,0 +1,317 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>UniqueConstraintException (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="UniqueConstraintException (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/UniqueConstraintException.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/TriggerFactory.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/UniqueConstraintException.html" target="_top">Frames</a></li> +<li><a href="UniqueConstraintException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class UniqueConstraintException" class="title">Class UniqueConstraintException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.PersistException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.ConstraintException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.UniqueConstraintException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UniqueConstraintException</span> +extends <a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.UniqueConstraintException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/UniqueConstraintException.html#UniqueConstraintException()">UniqueConstraintException</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.String)">UniqueConstraintException</a></strong>(java.lang.String message)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.String, java.lang.Throwable)">UniqueConstraintException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.Throwable)">UniqueConstraintException</a></strong>(java.lang.Throwable cause)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="UniqueConstraintException()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UniqueConstraintException</h4> +<pre>public UniqueConstraintException()</pre> +</li> +</ul> +<a name="UniqueConstraintException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UniqueConstraintException</h4> +<pre>public UniqueConstraintException(java.lang.String message)</pre> +</li> +</ul> +<a name="UniqueConstraintException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UniqueConstraintException</h4> +<pre>public UniqueConstraintException(java.lang.String message, + java.lang.Throwable cause)</pre> +</li> +</ul> +<a name="UniqueConstraintException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UniqueConstraintException</h4> +<pre>public UniqueConstraintException(java.lang.Throwable cause)</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/UniqueConstraintException.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/TriggerFactory.html" title="interface in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/UniqueConstraintException.html" target="_top">Frames</a></li> +<li><a href="UniqueConstraintException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_com.amazon.carbonado.RepositoryException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/UnsupportedTypeException.html b/apidocs/com/amazon/carbonado/UnsupportedTypeException.html new file mode 100644 index 0000000..d538038 --- /dev/null +++ b/apidocs/com/amazon/carbonado/UnsupportedTypeException.html @@ -0,0 +1,320 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>UnsupportedTypeException (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="UnsupportedTypeException (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/UnsupportedTypeException.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/UniqueConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/UnsupportedTypeException.html" target="_top">Frames</a></li> +<li><a href="UnsupportedTypeException.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><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</div> +<h2 title="Class UnsupportedTypeException" class="title">Class UnsupportedTypeException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.RepositoryException</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">com.amazon.carbonado.SupportException</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.UnsupportedTypeException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnsupportedTypeException</span> +extends <a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<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> +<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="../../../serialized-form.html#com.amazon.carbonado.UnsupportedTypeException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/UnsupportedTypeException.html#UnsupportedTypeException(java.lang.String, java.lang.Class)">UnsupportedTypeException</a></strong>(java.lang.String message, + java.lang.Class<? extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/UnsupportedTypeException.html#getMessage()">getMessage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/amazon/carbonado/UnsupportedTypeException.html#getType()">getType</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.RepositoryException"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></h3> +<code><a href="../../../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a>, <a href="../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="UnsupportedTypeException(java.lang.String, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UnsupportedTypeException</h4> +<pre>public UnsupportedTypeException(java.lang.String message, + java.lang.Class<? extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public java.lang.Class<? extends <a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getType()</pre> +</li> +</ul> +<a name="getMessage()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public java.lang.String getMessage()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>getMessage</code> in class <code>java.lang.Throwable</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/UnsupportedTypeException.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/UniqueConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/UnsupportedTypeException.html" target="_top">Frames</a></li> +<li><a href="UnsupportedTypeException.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><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> diff --git a/apidocs/com/amazon/carbonado/Version.html b/apidocs/com/amazon/carbonado/Version.html new file mode 100644 index 0000000..00ea984 --- /dev/null +++ b/apidocs/com/amazon/carbonado/Version.html @@ -0,0 +1,189 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Version (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="Version (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/Version.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/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Version.html" target="_top">Frames</a></li> +<li><a href="Version.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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</div> +<h2 title="Annotation Type Version" class="title">Annotation Type Version</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +public @interface <span class="strong">Version</span></pre> +<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. Only one property can have this + designation. + + <p>Philosophically, a version property can be considered part of the + identity of the storable. Unless the version is <a href="../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><code>Derived</code></a>, the + repository is responsible for establishing the version on insert, and for + auto-incrementing it on update. Under no circumstances should a normal + version property be incremented manually; this can result in a false <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a>, or worse may allow the persistent record to become + corrupted. + + <p>When updating a storable which has a normal version property, a value for + the version must be specified along with its primary key. Otherwise, an + <code>IllegalStateException</code> is thrown when calling update. If the update + operation detects that the specified version doesn't exactly match the + version of the existing persisted storable, an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> is thrown. For <a href="../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><code>Derived</code></a> versions, an <a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> is thrown only if the update detects that the new + version hasn't incremented. + + <p>The actual type of the version property can be anything, but some + repositories might only support integers. For maximum portability, version + properties should be a regular 32-bit int. + + <p>Example:<pre> + public interface UserInfo extends Storable { + <b>@Version</b> + int getRecordVersionNumber(); + void setRecordVersionNumber(int version); + + ... + } + </pre></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Don Schneider</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a></dd></dl> +</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/Version.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/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/Version.html" target="_top">Frames</a></li> +<li><a href="Version.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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> diff --git a/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html b/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html new file mode 100644 index 0000000..6b8dd93 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/AdapterDefinition.html @@ -0,0 +1,317 @@ +<!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>AdapterDefinition (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="AdapterDefinition (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/AdapterDefinition.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/AdapterDefinition.html" target="_top">Frames</a></li> +<li><a href="AdapterDefinition.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.adapter</div> +<h2 title="Annotation Type AdapterDefinition" class="title">Annotation Type AdapterDefinition</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=ANNOTATION_TYPE) +public @interface <span class="strong">AdapterDefinition</span></pre> +<div class="block">Allows annotations to be defined for supporting property types which are not + natively supported by the underlying storage layer. Repositories must always + attempt to match property types to the best matching native type, but they + may have to rely on an adapter to make a conversion. + + <p>The annotation is just a pointer to an adapter implementation class. If + the adapter class is not explicitly provided, it defaults to a static inner + class named "Adapter" in the annotation itself. + + <p>The adapter class must have a public constructor that accepts the + annotation that has the AdapterDefinition annotation. It must also define + several adapt methods which convert property values. An adapt method needs + to start with "adapt", accept one parameter and return something. + <p> + Example true/false adapter for booleans: + <pre> + @Documented + <b>@Retention(RetentionPolicy.RUNTIME)</b> + <b>@Target(ElementType.METHOD)</b> + <b>@AdapterDefinition</b> + public @interface TrueFalseAdapter { + + public static class Adapter { + private final String propertyName; + + // Constructor may throw a MalformedTypeException if + // params supplied by annotation are illegal. + + /** + * @param type optional type of object that contains the adapted property + * @param propertyName name of property with adapter + * @param annotation specific annotation that binds to this adapter class + */ + public Adapter(Class type, String propertyName, TrueFalseAdapter annotation) { + this.propertyName = propertyName; + } + + // Define at least two adapt methods for each supported property type. + + /** + * @param propertyValue value to convert from + */ + public char adaptToChar(boolean propertyValue) { + return value ? 'T' : 'F'; + } + + /** + * @param propertyValue value to convert from + */ + public boolean adaptToBoolean(char propertyValue) { + if (propertyValue == 'T') { return true; }; + if (propertyValue == 'F') { return false; }; + throw new IllegalArgumentException + ("Cannot adapt '" + value + "' into boolean for property \"" + + propertyName + '"'); + } + } + } + </pre> + + The newly defined adapter can be applied to property accessors. + + <pre> + public interface UserInfo extends Storable { + <b>@TrueFalseAdapter</b> + boolean isAdministrator(); + void setAdministrator(boolean admin); + } + </pre></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"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#implementation()">implementation</a></strong></code> +<div class="block">Specify class which will perform property adaptation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()">storageTypePreferences</a></strong></code> +<div class="block">Optionally specify the set of preferred storage types for storing the + adapted property, in order of most preferred to least preferred.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="implementation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>implementation</h4> +<pre>public abstract java.lang.Class implementation</pre> +<div class="block">Specify class which will perform property adaptation. Must have a public + constructor with the signature + <code>(Class type, String propertyName, <i>Annotation</i>)</code>, + where <code><i>Annotation</i></code> refers to the annotation with the + adapter definition. + + <p>The implementation class need not be explicitly specified. By + default, the adapter class must be a static inner class of the + annotation, named "Adapter".</div> +<dl> +<dt>Default:</dt> +<dd>void.class</dd> +</dl> +</li> +</ul> +<a name="storageTypePreferences()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>storageTypePreferences</h4> +<pre>public abstract java.lang.Class[] storageTypePreferences</pre> +<div class="block">Optionally specify the set of preferred storage types for storing the + adapted property, in order of most preferred to least preferred. A type + in the set must be supported by the adapt methods to be considered. + + <p>If the repository is independent, it needs help on deciding exactly + how to store the adapted property. A dependent repository will not have + as much flexibility in selecting an appropriate type, but it may still + need a hint.</div> +<dl> +<dt>Default:</dt> +<dd>{}</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/AdapterDefinition.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/AdapterDefinition.html" target="_top">Frames</a></li> +<li><a href="AdapterDefinition.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html new file mode 100644 index 0000000..643f670 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html @@ -0,0 +1,1052 @@ +<!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>DateTimeAdapter.Adapter (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="DateTimeAdapter.Adapter (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/DateTimeAdapter.Adapter.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/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="DateTimeAdapter.Adapter.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><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.adapter</div> +<h2 title="Class DateTimeAdapter.Adapter" class="title">Class DateTimeAdapter.Adapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.adapter.DateTimeAdapter.Adapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">DateTimeAdapter.Adapter</span> +extends java.lang.Object</pre> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>DateTimeAdapter</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/adapter/DateTimeAdapter.Adapter.html#DateTimeAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.DateTimeAdapter)">DateTimeAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a> ann)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#DateTimeAdapter.Adapter(java.lang.Class, java.lang.String, org.joda.time.DateTimeZone)">DateTimeAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + org.joda.time.DateTimeZone zone)</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>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.sql.Date)">adaptToDate</a></strong>(java.sql.Date date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(org.joda.time.LocalDate)">adaptToDate</a></strong>(org.joda.time.LocalDate date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(org.joda.time.LocalDateTime)">adaptToDate</a></strong>(org.joda.time.LocalDateTime dateTime)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(long)">adaptToDate</a></strong>(long instant)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.lang.Long)">adaptToDate</a></strong>(java.lang.Long instant)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(org.joda.time.ReadableInstant)">adaptToDate</a></strong>(org.joda.time.ReadableInstant instant)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.lang.String)">adaptToDate</a></strong>(java.lang.String isoDateString)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.sql.Time)">adaptToDate</a></strong>(java.sql.Time time)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.sql.Timestamp)">adaptToDate</a></strong>(java.sql.Timestamp timestamp)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.DateMidnight</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.util.Date)">adaptToDateMidnight</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.DateMidnight</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.sql.Date)">adaptToDateMidnight</a></strong>(java.sql.Date date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.DateMidnight</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(long)">adaptToDateMidnight</a></strong>(long instant)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.DateMidnight</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.lang.Long)">adaptToDateMidnight</a></strong>(java.lang.Long instant)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.DateMidnight</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.lang.String)">adaptToDateMidnight</a></strong>(java.lang.String isoDateString)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.DateMidnight</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.sql.Time)">adaptToDateMidnight</a></strong>(java.sql.Time time)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.DateMidnight</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.sql.Timestamp)">adaptToDateMidnight</a></strong>(java.sql.Timestamp timestamp)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.DateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.util.Date)">adaptToDateTime</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.DateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.sql.Date)">adaptToDateTime</a></strong>(java.sql.Date date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.DateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(long)">adaptToDateTime</a></strong>(long instant)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.DateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.lang.Long)">adaptToDateTime</a></strong>(java.lang.Long instant)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.DateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.lang.String)">adaptToDateTime</a></strong>(java.lang.String isoDateString)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.DateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.sql.Time)">adaptToDateTime</a></strong>(java.sql.Time time)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.DateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.sql.Timestamp)">adaptToDateTime</a></strong>(java.sql.Timestamp timestamp)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.LocalDate</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.util.Date)">adaptToLocalDate</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.LocalDate</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.sql.Date)">adaptToLocalDate</a></strong>(java.sql.Date date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.LocalDate</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(long)">adaptToLocalDate</a></strong>(long instant)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.LocalDate</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.lang.Long)">adaptToLocalDate</a></strong>(java.lang.Long instant)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.LocalDate</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.lang.String)">adaptToLocalDate</a></strong>(java.lang.String isoDateString)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.LocalDate</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.sql.Time)">adaptToLocalDate</a></strong>(java.sql.Time time)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.LocalDate</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.sql.Timestamp)">adaptToLocalDate</a></strong>(java.sql.Timestamp timestamp)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.LocalDateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.util.Date)">adaptToLocalDateTime</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.LocalDateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.sql.Date)">adaptToLocalDateTime</a></strong>(java.sql.Date date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.LocalDateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(long)">adaptToLocalDateTime</a></strong>(long instant)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.LocalDateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.lang.Long)">adaptToLocalDateTime</a></strong>(java.lang.Long instant)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.LocalDateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.lang.String)">adaptToLocalDateTime</a></strong>(java.lang.String isoDateString)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.LocalDateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.sql.Time)">adaptToLocalDateTime</a></strong>(java.sql.Time time)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.joda.time.LocalDateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.sql.Timestamp)">adaptToLocalDateTime</a></strong>(java.sql.Timestamp timestamp)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLong(java.util.Date)">adaptToLong</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLong(org.joda.time.LocalDate)">adaptToLong</a></strong>(org.joda.time.LocalDate date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLong(org.joda.time.LocalDateTime)">adaptToLong</a></strong>(org.joda.time.LocalDateTime dateTime)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLong(org.joda.time.ReadableInstant)">adaptToLong</a></strong>(org.joda.time.ReadableInstant instant)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLongObj(java.util.Date)">adaptToLongObj</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLongObj(org.joda.time.LocalDate)">adaptToLongObj</a></strong>(org.joda.time.LocalDate date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLongObj(org.joda.time.LocalDateTime)">adaptToLongObj</a></strong>(org.joda.time.LocalDateTime dateTime)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLongObj(org.joda.time.ReadableInstant)">adaptToLongObj</a></strong>(org.joda.time.ReadableInstant instant)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlDate(java.util.Date)">adaptToSqlDate</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlDate(org.joda.time.LocalDate)">adaptToSqlDate</a></strong>(org.joda.time.LocalDate date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlDate(org.joda.time.LocalDateTime)">adaptToSqlDate</a></strong>(org.joda.time.LocalDateTime dateTime)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlDate(org.joda.time.ReadableInstant)">adaptToSqlDate</a></strong>(org.joda.time.ReadableInstant instant)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Time</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTime(java.util.Date)">adaptToSqlTime</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Time</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTime(org.joda.time.LocalDateTime)">adaptToSqlTime</a></strong>(org.joda.time.LocalDateTime dateTime)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Time</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTime(org.joda.time.ReadableInstant)">adaptToSqlTime</a></strong>(org.joda.time.ReadableInstant instant)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Timestamp</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTimestamp(java.util.Date)">adaptToSqlTimestamp</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Timestamp</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTimestamp(org.joda.time.LocalDate)">adaptToSqlTimestamp</a></strong>(org.joda.time.LocalDate date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Timestamp</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTimestamp(org.joda.time.LocalDateTime)">adaptToSqlTimestamp</a></strong>(org.joda.time.LocalDateTime dateTime)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Timestamp</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTimestamp(org.joda.time.ReadableInstant)">adaptToSqlTimestamp</a></strong>(org.joda.time.ReadableInstant instant)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToString(java.util.Date)">adaptToString</a></strong>(java.util.Date date)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToString(org.joda.time.LocalDate)">adaptToString</a></strong>(org.joda.time.LocalDate date)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToString(org.joda.time.LocalDateTime)">adaptToString</a></strong>(org.joda.time.LocalDateTime dateTime)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToString(org.joda.time.ReadableInstant)">adaptToString</a></strong>(org.joda.time.ReadableInstant instant)</code> </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> +</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="DateTimeAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.DateTimeAdapter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DateTimeAdapter.Adapter</h4> +<pre>public DateTimeAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with adapter</dd><dd><code>ann</code> - specific annotation that binds to this adapter class</dd></dl> +</li> +</ul> +<a name="DateTimeAdapter.Adapter(java.lang.Class, java.lang.String, org.joda.time.DateTimeZone)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DateTimeAdapter.Adapter</h4> +<pre>public DateTimeAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + org.joda.time.DateTimeZone zone)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with</dd><dd><code>zone</code> - time zone to apply, or null to use default</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="adaptToDateTime(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateTime</h4> +<pre>public org.joda.time.DateTime adaptToDateTime(long instant)</pre> +</li> +</ul> +<a name="adaptToDateTime(java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateTime</h4> +<pre>public org.joda.time.DateTime adaptToDateTime(java.lang.Long instant)</pre> +</li> +</ul> +<a name="adaptToDateTime(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateTime</h4> +<pre>public org.joda.time.DateTime adaptToDateTime(java.lang.String isoDateString)</pre> +</li> +</ul> +<a name="adaptToDateTime(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateTime</h4> +<pre>public org.joda.time.DateTime adaptToDateTime(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToDateTime(java.sql.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateTime</h4> +<pre>public org.joda.time.DateTime adaptToDateTime(java.sql.Date date)</pre> +</li> +</ul> +<a name="adaptToDateTime(java.sql.Time)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateTime</h4> +<pre>public org.joda.time.DateTime adaptToDateTime(java.sql.Time time)</pre> +</li> +</ul> +<a name="adaptToDateTime(java.sql.Timestamp)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateTime</h4> +<pre>public org.joda.time.DateTime adaptToDateTime(java.sql.Timestamp timestamp)</pre> +</li> +</ul> +<a name="adaptToDateMidnight(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateMidnight</h4> +<pre>public org.joda.time.DateMidnight adaptToDateMidnight(long instant)</pre> +</li> +</ul> +<a name="adaptToDateMidnight(java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateMidnight</h4> +<pre>public org.joda.time.DateMidnight adaptToDateMidnight(java.lang.Long instant)</pre> +</li> +</ul> +<a name="adaptToDateMidnight(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateMidnight</h4> +<pre>public org.joda.time.DateMidnight adaptToDateMidnight(java.lang.String isoDateString)</pre> +</li> +</ul> +<a name="adaptToDateMidnight(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateMidnight</h4> +<pre>public org.joda.time.DateMidnight adaptToDateMidnight(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToDateMidnight(java.sql.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateMidnight</h4> +<pre>public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Date date)</pre> +</li> +</ul> +<a name="adaptToDateMidnight(java.sql.Time)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateMidnight</h4> +<pre>public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Time time)</pre> +</li> +</ul> +<a name="adaptToDateMidnight(java.sql.Timestamp)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDateMidnight</h4> +<pre>public org.joda.time.DateMidnight adaptToDateMidnight(java.sql.Timestamp timestamp)</pre> +</li> +</ul> +<a name="adaptToLocalDateTime(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDateTime</h4> +<pre>public org.joda.time.LocalDateTime adaptToLocalDateTime(long instant)</pre> +</li> +</ul> +<a name="adaptToLocalDateTime(java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDateTime</h4> +<pre>public org.joda.time.LocalDateTime adaptToLocalDateTime(java.lang.Long instant)</pre> +</li> +</ul> +<a name="adaptToLocalDateTime(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDateTime</h4> +<pre>public org.joda.time.LocalDateTime adaptToLocalDateTime(java.lang.String isoDateString)</pre> +</li> +</ul> +<a name="adaptToLocalDateTime(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDateTime</h4> +<pre>public org.joda.time.LocalDateTime adaptToLocalDateTime(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToLocalDateTime(java.sql.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDateTime</h4> +<pre>public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Date date)</pre> +</li> +</ul> +<a name="adaptToLocalDateTime(java.sql.Time)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDateTime</h4> +<pre>public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Time time)</pre> +</li> +</ul> +<a name="adaptToLocalDateTime(java.sql.Timestamp)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDateTime</h4> +<pre>public org.joda.time.LocalDateTime adaptToLocalDateTime(java.sql.Timestamp timestamp)</pre> +</li> +</ul> +<a name="adaptToLocalDate(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDate</h4> +<pre>public org.joda.time.LocalDate adaptToLocalDate(long instant)</pre> +</li> +</ul> +<a name="adaptToLocalDate(java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDate</h4> +<pre>public org.joda.time.LocalDate adaptToLocalDate(java.lang.Long instant)</pre> +</li> +</ul> +<a name="adaptToLocalDate(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDate</h4> +<pre>public org.joda.time.LocalDate adaptToLocalDate(java.lang.String isoDateString)</pre> +</li> +</ul> +<a name="adaptToLocalDate(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDate</h4> +<pre>public org.joda.time.LocalDate adaptToLocalDate(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToLocalDate(java.sql.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDate</h4> +<pre>public org.joda.time.LocalDate adaptToLocalDate(java.sql.Date date)</pre> +</li> +</ul> +<a name="adaptToLocalDate(java.sql.Time)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDate</h4> +<pre>public org.joda.time.LocalDate adaptToLocalDate(java.sql.Time time)</pre> +</li> +</ul> +<a name="adaptToLocalDate(java.sql.Timestamp)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLocalDate</h4> +<pre>public org.joda.time.LocalDate adaptToLocalDate(java.sql.Timestamp timestamp)</pre> +</li> +</ul> +<a name="adaptToLong(org.joda.time.ReadableInstant)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLong</h4> +<pre>public long adaptToLong(org.joda.time.ReadableInstant instant)</pre> +</li> +</ul> +<a name="adaptToLongObj(org.joda.time.ReadableInstant)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLongObj</h4> +<pre>public java.lang.Long adaptToLongObj(org.joda.time.ReadableInstant instant)</pre> +</li> +</ul> +<a name="adaptToString(org.joda.time.ReadableInstant)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(org.joda.time.ReadableInstant instant)</pre> +</li> +</ul> +<a name="adaptToDate(org.joda.time.ReadableInstant)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(org.joda.time.ReadableInstant instant)</pre> +</li> +</ul> +<a name="adaptToSqlDate(org.joda.time.ReadableInstant)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlDate</h4> +<pre>public java.sql.Date adaptToSqlDate(org.joda.time.ReadableInstant instant)</pre> +</li> +</ul> +<a name="adaptToSqlTime(org.joda.time.ReadableInstant)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlTime</h4> +<pre>public java.sql.Time adaptToSqlTime(org.joda.time.ReadableInstant instant)</pre> +</li> +</ul> +<a name="adaptToSqlTimestamp(org.joda.time.ReadableInstant)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlTimestamp</h4> +<pre>public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.ReadableInstant instant)</pre> +</li> +</ul> +<a name="adaptToLong(org.joda.time.LocalDateTime)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLong</h4> +<pre>public long adaptToLong(org.joda.time.LocalDateTime dateTime)</pre> +</li> +</ul> +<a name="adaptToLongObj(org.joda.time.LocalDateTime)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLongObj</h4> +<pre>public java.lang.Long adaptToLongObj(org.joda.time.LocalDateTime dateTime)</pre> +</li> +</ul> +<a name="adaptToString(org.joda.time.LocalDateTime)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(org.joda.time.LocalDateTime dateTime)</pre> +</li> +</ul> +<a name="adaptToDate(org.joda.time.LocalDateTime)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(org.joda.time.LocalDateTime dateTime)</pre> +</li> +</ul> +<a name="adaptToSqlDate(org.joda.time.LocalDateTime)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlDate</h4> +<pre>public java.sql.Date adaptToSqlDate(org.joda.time.LocalDateTime dateTime)</pre> +</li> +</ul> +<a name="adaptToSqlTime(org.joda.time.LocalDateTime)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlTime</h4> +<pre>public java.sql.Time adaptToSqlTime(org.joda.time.LocalDateTime dateTime)</pre> +</li> +</ul> +<a name="adaptToSqlTimestamp(org.joda.time.LocalDateTime)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlTimestamp</h4> +<pre>public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.LocalDateTime dateTime)</pre> +</li> +</ul> +<a name="adaptToLong(org.joda.time.LocalDate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLong</h4> +<pre>public long adaptToLong(org.joda.time.LocalDate date)</pre> +</li> +</ul> +<a name="adaptToLongObj(org.joda.time.LocalDate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLongObj</h4> +<pre>public java.lang.Long adaptToLongObj(org.joda.time.LocalDate date)</pre> +</li> +</ul> +<a name="adaptToString(org.joda.time.LocalDate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(org.joda.time.LocalDate date)</pre> +</li> +</ul> +<a name="adaptToDate(org.joda.time.LocalDate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(org.joda.time.LocalDate date)</pre> +</li> +</ul> +<a name="adaptToSqlDate(org.joda.time.LocalDate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlDate</h4> +<pre>public java.sql.Date adaptToSqlDate(org.joda.time.LocalDate date)</pre> +</li> +</ul> +<a name="adaptToSqlTimestamp(org.joda.time.LocalDate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlTimestamp</h4> +<pre>public java.sql.Timestamp adaptToSqlTimestamp(org.joda.time.LocalDate date)</pre> +</li> +</ul> +<a name="adaptToDate(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(long instant)</pre> +</li> +</ul> +<a name="adaptToDate(java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(java.lang.Long instant)</pre> +</li> +</ul> +<a name="adaptToDate(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(java.lang.String isoDateString)</pre> +</li> +</ul> +<a name="adaptToDate(java.sql.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(java.sql.Date date)</pre> +</li> +</ul> +<a name="adaptToDate(java.sql.Time)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(java.sql.Time time)</pre> +</li> +</ul> +<a name="adaptToDate(java.sql.Timestamp)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDate</h4> +<pre>public java.util.Date adaptToDate(java.sql.Timestamp timestamp)</pre> +</li> +</ul> +<a name="adaptToLong(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLong</h4> +<pre>public long adaptToLong(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToLongObj(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLongObj</h4> +<pre>public java.lang.Long adaptToLongObj(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToString(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToSqlDate(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlDate</h4> +<pre>public java.sql.Date adaptToSqlDate(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToSqlTime(java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToSqlTime</h4> +<pre>public java.sql.Time adaptToSqlTime(java.util.Date date)</pre> +</li> +</ul> +<a name="adaptToSqlTimestamp(java.util.Date)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>adaptToSqlTimestamp</h4> +<pre>public java.sql.Timestamp adaptToSqlTimestamp(java.util.Date date)</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/DateTimeAdapter.Adapter.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/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="DateTimeAdapter.Adapter.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><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> diff --git a/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.html b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.html new file mode 100644 index 0000000..8bcca50 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/DateTimeAdapter.html @@ -0,0 +1,231 @@ +<!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>DateTimeAdapter (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="DateTimeAdapter (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/DateTimeAdapter.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/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/DateTimeAdapter.html" target="_top">Frames</a></li> +<li><a href="DateTimeAdapter.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.adapter</div> +<h2 title="Annotation Type DateTimeAdapter" class="title">Annotation Type DateTimeAdapter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">@AdapterDefinition</a>(<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()">storageTypePreferences</a>={long.class,java.lang.Long.class,java.lang.String.class}) +public @interface <span class="strong">DateTimeAdapter</span></pre> +<div class="block">Converts Joda-Time datetime objects to and from other forms. This adapter is + applied automatically for all storable properties of type <code>DateTime</code>, + <code>DateMidnight</code>, <code>LocalDateTime</code>, <code>LocalDate</code> and also + <code>Date</code>. Explicit use allows a different time zone to be + used, but this only works for Joda-Time objects. + + <p>Example:<pre> + public interface UserInfo extends Storable { + <b>@DateTimeAdapter(timeZone="UTC")</b> + DateTime getModifyDateTime(); + void setModifyDateTime(DateTime dt); + + ... + } + </pre></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Justin Rudd</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>AdapterDefinition</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html#timeZone()">timeZone</a></strong></code> +<div class="block">Optionally specify a time zone to apply to new DateTimes, overriding the + default time zone.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="timeZone()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>timeZone</h4> +<pre>public abstract java.lang.String timeZone</pre> +<div class="block">Optionally specify a time zone to apply to new DateTimes, overriding the + default time zone.</div> +<dl> +<dt>Default:</dt> +<dd>""</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/DateTimeAdapter.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/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/DateTimeAdapter.html" target="_top">Frames</a></li> +<li><a href="DateTimeAdapter.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html new file mode 100644 index 0000000..ad825fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html @@ -0,0 +1,455 @@ +<!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>PrimitiveArrayAdapter.Adapter (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="PrimitiveArrayAdapter.Adapter (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/PrimitiveArrayAdapter.Adapter.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/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="PrimitiveArrayAdapter.Adapter.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><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.adapter</div> +<h2 title="Class PrimitiveArrayAdapter.Adapter" class="title">Class PrimitiveArrayAdapter.Adapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">PrimitiveArrayAdapter.Adapter</span> +extends java.lang.Object</pre> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>PrimitiveArrayAdapter</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/adapter/PrimitiveArrayAdapter.Adapter.html#PrimitiveArrayAdapter.Adapter()">PrimitiveArrayAdapter.Adapter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#PrimitiveArrayAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.PrimitiveArrayAdapter)">PrimitiveArrayAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a> ann)</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>boolean[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToBooleanArray(byte[])">adaptToBooleanArray</a></strong>(byte[] src)</code> +<div class="block">Unpacks a boolean array from a byte array, big-endian fashion.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(boolean[])">adaptToByteArray</a></strong>(boolean[] src)</code> +<div class="block">Packs the given boolean array into a byte array, big-endian fashion.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(char[])">adaptToByteArray</a></strong>(char[] src)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(double[])">adaptToByteArray</a></strong>(double[] src)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(float[])">adaptToByteArray</a></strong>(float[] src)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(int[])">adaptToByteArray</a></strong>(int[] src)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(long[])">adaptToByteArray</a></strong>(long[] src)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(short[])">adaptToByteArray</a></strong>(short[] src)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>char[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToCharArray(byte[])">adaptToCharArray</a></strong>(byte[] src)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToDoubleArray(byte[])">adaptToDoubleArray</a></strong>(byte[] src)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>float[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToFloatArray(byte[])">adaptToFloatArray</a></strong>(byte[] src)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToIntArray(byte[])">adaptToIntArray</a></strong>(byte[] src)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToLongArray(byte[])">adaptToLongArray</a></strong>(byte[] src)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>short[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToShortArray(byte[])">adaptToShortArray</a></strong>(byte[] src)</code> </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> +</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="PrimitiveArrayAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.PrimitiveArrayAdapter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PrimitiveArrayAdapter.Adapter</h4> +<pre>public PrimitiveArrayAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with adapter</dd><dd><code>ann</code> - specific annotation that binds to this adapter class</dd></dl> +</li> +</ul> +<a name="PrimitiveArrayAdapter.Adapter()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PrimitiveArrayAdapter.Adapter</h4> +<pre>public PrimitiveArrayAdapter.Adapter()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="adaptToByteArray(short[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToByteArray</h4> +<pre>public byte[] adaptToByteArray(short[] src)</pre> +</li> +</ul> +<a name="adaptToByteArray(char[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToByteArray</h4> +<pre>public byte[] adaptToByteArray(char[] src)</pre> +</li> +</ul> +<a name="adaptToByteArray(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToByteArray</h4> +<pre>public byte[] adaptToByteArray(int[] src)</pre> +</li> +</ul> +<a name="adaptToByteArray(long[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToByteArray</h4> +<pre>public byte[] adaptToByteArray(long[] src)</pre> +</li> +</ul> +<a name="adaptToByteArray(float[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToByteArray</h4> +<pre>public byte[] adaptToByteArray(float[] src)</pre> +</li> +</ul> +<a name="adaptToByteArray(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToByteArray</h4> +<pre>public byte[] adaptToByteArray(double[] src)</pre> +</li> +</ul> +<a name="adaptToByteArray(boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToByteArray</h4> +<pre>public byte[] adaptToByteArray(boolean[] src)</pre> +<div class="block">Packs the given boolean array into a byte array, big-endian fashion.</div> +</li> +</ul> +<a name="adaptToShortArray(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToShortArray</h4> +<pre>public short[] adaptToShortArray(byte[] src)</pre> +</li> +</ul> +<a name="adaptToCharArray(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToCharArray</h4> +<pre>public char[] adaptToCharArray(byte[] src)</pre> +</li> +</ul> +<a name="adaptToIntArray(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToIntArray</h4> +<pre>public int[] adaptToIntArray(byte[] src)</pre> +</li> +</ul> +<a name="adaptToLongArray(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToLongArray</h4> +<pre>public long[] adaptToLongArray(byte[] src)</pre> +</li> +</ul> +<a name="adaptToFloatArray(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToFloatArray</h4> +<pre>public float[] adaptToFloatArray(byte[] src)</pre> +</li> +</ul> +<a name="adaptToDoubleArray(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToDoubleArray</h4> +<pre>public double[] adaptToDoubleArray(byte[] src)</pre> +</li> +</ul> +<a name="adaptToBooleanArray(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>adaptToBooleanArray</h4> +<pre>public boolean[] adaptToBooleanArray(byte[] src)</pre> +<div class="block">Unpacks a boolean array from a byte array, big-endian fashion.</div> +</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/PrimitiveArrayAdapter.Adapter.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/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="PrimitiveArrayAdapter.Adapter.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><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> diff --git a/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html new file mode 100644 index 0000000..04a3a5d --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html @@ -0,0 +1,161 @@ +<!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>PrimitiveArrayAdapter (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="PrimitiveArrayAdapter (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/PrimitiveArrayAdapter.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/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" target="_top">Frames</a></li> +<li><a href="PrimitiveArrayAdapter.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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.adapter</div> +<h2 title="Annotation Type PrimitiveArrayAdapter" class="title">Annotation Type PrimitiveArrayAdapter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">@AdapterDefinition</a>(<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()">storageTypePreferences</a>=byte[].class) +public @interface <span class="strong">PrimitiveArrayAdapter</span></pre> +<div class="block">Allows arrays of primitive types to be encoded (big-endian) as byte arrays.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</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/PrimitiveArrayAdapter.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/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" target="_top">Frames</a></li> +<li><a href="PrimitiveArrayAdapter.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>Required | </li> +<li>Optional</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Element</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> diff --git a/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html new file mode 100644 index 0000000..7d1ef87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TextAdapter.Adapter.html @@ -0,0 +1,370 @@ +<!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>TextAdapter.Adapter (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="TextAdapter.Adapter (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/TextAdapter.Adapter.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/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/TextAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="TextAdapter.Adapter.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><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.adapter</div> +<h2 title="Class TextAdapter.Adapter" class="title">Class TextAdapter.Adapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.adapter.TextAdapter.Adapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">TextAdapter.Adapter</span> +extends java.lang.Object</pre> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TextAdapter</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.nio.charset.Charset)">TextAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + java.nio.charset.Charset charset)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.nio.charset.Charset, java.nio.charset.Charset[])">TextAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + java.nio.charset.Charset charset, + java.nio.charset.Charset[] altCharsets)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.lang.String)">TextAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + java.lang.String charset)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TextAdapter)">TextAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a> ann)</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/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToBlob(java.lang.String)">adaptToBlob</a></strong>(java.lang.String text)</code> </td> +</tr> +<tr class="rowColor"> +<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/adapter/TextAdapter.Adapter.html#adaptToClob(java.lang.String)">adaptToClob</a></strong>(java.lang.String text)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Blob)">adaptToString</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Clob)">adaptToString</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </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> +</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="TextAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TextAdapter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TextAdapter.Adapter</h4> +<pre>public TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with adapter</dd><dd><code>ann</code> - specific annotation that binds to this adapter class</dd></dl> +</li> +</ul> +<a name="TextAdapter.Adapter(java.lang.Class, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TextAdapter.Adapter</h4> +<pre>public TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.lang.String charset)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with</dd><dd><code>charset</code> - character set to use, or null to use default of UTF-8.</dd></dl> +</li> +</ul> +<a name="TextAdapter.Adapter(java.lang.Class, java.lang.String, java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TextAdapter.Adapter</h4> +<pre>public TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.nio.charset.Charset charset)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with</dd><dd><code>charset</code> - character set to use, or null to use default of UTF-8.</dd></dl> +</li> +</ul> +<a name="TextAdapter.Adapter(java.lang.Class, java.lang.String, java.nio.charset.Charset, java.nio.charset.Charset[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TextAdapter.Adapter</h4> +<pre>public TextAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + java.nio.charset.Charset charset, + java.nio.charset.Charset[] altCharsets)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with</dd><dd><code>charset</code> - character set to use, or null to use default of UTF-8.</dd><dd><code>altCharsets</code> - alternate character sets to use, if text cannot be + decoded with primary charset</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="adaptToString(com.amazon.carbonado.lob.Clob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><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="adaptToString(com.amazon.carbonado.lob.Blob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><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="adaptToClob(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToClob</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> adaptToClob(java.lang.String text)</pre> +</li> +</ul> +<a name="adaptToBlob(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>adaptToBlob</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> adaptToBlob(java.lang.String text) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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></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/TextAdapter.Adapter.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/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/TextAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="TextAdapter.Adapter.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><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> diff --git a/apidocs/com/amazon/carbonado/adapter/TextAdapter.html b/apidocs/com/amazon/carbonado/adapter/TextAdapter.html new file mode 100644 index 0000000..71853c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TextAdapter.html @@ -0,0 +1,253 @@ +<!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>TextAdapter (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="TextAdapter (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/TextAdapter.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/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/TextAdapter.html" target="_top">Frames</a></li> +<li><a href="TextAdapter.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.adapter</div> +<h2 title="Annotation Type TextAdapter" class="title">Annotation Type TextAdapter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">@AdapterDefinition</a>(<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()">storageTypePreferences</a>={java.lang.String.class,<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob.class</a>,<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob.class</a>}) +public @interface <span class="strong">TextAdapter</span></pre> +<div class="block">Converts database Blobs and Clobs to Strings. This is suitable for text + values which are expected to fit entirely in memory. The storage layer will + attempt to store the text as a regular string, but will use a blob type if + required to. + + <p>Example:<pre> + public interface UserInfo extends Storable { + <b>@TextAdapter(charset="UTF-8")</b> + String getWelcomeMessage(); + void setWelcomeMessage(String message); + + ... + } + </pre></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/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clob</code></a>, +<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blob</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html#altCharsets()">altCharsets</a></strong></code> +<div class="block">Optionally specify alternate character sets, which are used if text + cannot be decoded with primary charset.</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/adapter/TextAdapter.html#charset()">charset</a></strong></code> +<div class="block">Optionally specify a character set, which is used if the storage type is + a Blob.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="charset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>charset</h4> +<pre>public abstract java.lang.String charset</pre> +<div class="block">Optionally specify a character set, which is used if the storage type is + a Blob.</div> +<dl> +<dt>Default:</dt> +<dd>"UTF-8"</dd> +</dl> +</li> +</ul> +<a name="altCharsets()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>altCharsets</h4> +<pre>public abstract java.lang.String[] altCharsets</pre> +<div class="block">Optionally specify alternate character sets, which are used if text + cannot be decoded with primary charset.</div> +<dl> +<dt>Default:</dt> +<dd>{}</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/TextAdapter.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/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/TextAdapter.html" target="_top">Frames</a></li> +<li><a href="TextAdapter.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html new file mode 100644 index 0000000..0d6ea7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html @@ -0,0 +1,470 @@ +<!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>TrueFalseAdapter.Adapter (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="TrueFalseAdapter.Adapter (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/TrueFalseAdapter.Adapter.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/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="TrueFalseAdapter.Adapter.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><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.adapter</div> +<h2 title="Class TrueFalseAdapter.Adapter" class="title">Class TrueFalseAdapter.Adapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">TrueFalseAdapter.Adapter</span> +extends java.lang.Object</pre> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TrueFalseAdapter</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/adapter/TrueFalseAdapter.Adapter.html#TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, boolean)">TrueFalseAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + boolean lenient)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TrueFalseAdapter)">TrueFalseAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a> ann)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBoolean(char)">adaptToBoolean</a></strong>(char value)</code> +<div class="block">Adapts a character 'T' or 'F' to true or false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBoolean(java.lang.Character)">adaptToBoolean</a></strong>(java.lang.Character value)</code> +<div class="block">Adapts a character 'T' or 'F' to true or false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBoolean(java.lang.String)">adaptToBoolean</a></strong>(java.lang.String value)</code> +<div class="block">Adapts a character "T" or "F" to true or false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBooleanObj(char)">adaptToBooleanObj</a></strong>(char value)</code> +<div class="block">Adapts a character 'T' or 'F' to true or false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBooleanObj(java.lang.Character)">adaptToBooleanObj</a></strong>(java.lang.Character value)</code> +<div class="block">Adapts a character 'T' or 'F' to true or false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBooleanObj(java.lang.String)">adaptToBooleanObj</a></strong>(java.lang.String value)</code> +<div class="block">Adapts a character "T" or "F" to true or false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToChar(boolean)">adaptToChar</a></strong>(boolean value)</code> +<div class="block">Adapts a boolean true or false into 'T' or 'F'.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToChar(java.lang.Boolean)">adaptToChar</a></strong>(java.lang.Boolean value)</code> +<div class="block">Adapts a boolean true into 'T', and anything else to 'F'.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Character</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToCharacter(boolean)">adaptToCharacter</a></strong>(boolean value)</code> +<div class="block">Adapts a boolean true or false into 'T' or 'F'.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Character</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToCharacter(java.lang.Boolean)">adaptToCharacter</a></strong>(java.lang.Boolean value)</code> +<div class="block">Adapts a boolean true into 'T', and anything else to 'F'.</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/adapter/TrueFalseAdapter.Adapter.html#adaptToString(boolean)">adaptToString</a></strong>(boolean value)</code> +<div class="block">Adapts a boolean true or false into "T" or "F".</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/adapter/TrueFalseAdapter.Adapter.html#adaptToString(java.lang.Boolean)">adaptToString</a></strong>(java.lang.Boolean value)</code> +<div class="block">Adapts a boolean true into "T", and anything else to "F".</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> +</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="TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TrueFalseAdapter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TrueFalseAdapter.Adapter</h4> +<pre>public TrueFalseAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with adapter</dd><dd><code>ann</code> - specific annotation that binds to this adapter class</dd></dl> +</li> +</ul> +<a name="TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TrueFalseAdapter.Adapter</h4> +<pre>public TrueFalseAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + boolean lenient)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with</dd><dd><code>lenient</code> - lenient when true</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="adaptToChar(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToChar</h4> +<pre>public char adaptToChar(boolean value)</pre> +<div class="block">Adapts a boolean true or false into 'T' or 'F'.</div> +</li> +</ul> +<a name="adaptToChar(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToChar</h4> +<pre>public char adaptToChar(java.lang.Boolean value)</pre> +<div class="block">Adapts a boolean true into 'T', and anything else to 'F'.</div> +</li> +</ul> +<a name="adaptToCharacter(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToCharacter</h4> +<pre>public java.lang.Character adaptToCharacter(boolean value)</pre> +<div class="block">Adapts a boolean true or false into 'T' or 'F'.</div> +</li> +</ul> +<a name="adaptToCharacter(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToCharacter</h4> +<pre>public java.lang.Character adaptToCharacter(java.lang.Boolean value)</pre> +<div class="block">Adapts a boolean true into 'T', and anything else to 'F'.</div> +</li> +</ul> +<a name="adaptToString(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(boolean value)</pre> +<div class="block">Adapts a boolean true or false into "T" or "F".</div> +</li> +</ul> +<a name="adaptToString(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(java.lang.Boolean value)</pre> +<div class="block">Adapts a boolean true into "T", and anything else to "F".</div> +</li> +</ul> +<a name="adaptToBoolean(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBoolean</h4> +<pre>public boolean adaptToBoolean(char value)</pre> +<div class="block">Adapts a character 'T' or 'F' to true or false. If <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBoolean(java.lang.Character)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBoolean</h4> +<pre>public boolean adaptToBoolean(java.lang.Character value)</pre> +<div class="block">Adapts a character 'T' or 'F' to true or false. If <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBoolean(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBoolean</h4> +<pre>public boolean adaptToBoolean(java.lang.String value)</pre> +<div class="block">Adapts a character "T" or "F" to true or false. If <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html#lenient()"><code>leneint</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBooleanObj(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBooleanObj</h4> +<pre>public java.lang.Boolean adaptToBooleanObj(char value)</pre> +<div class="block">Adapts a character 'T' or 'F' to true or false. If <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBooleanObj(java.lang.Character)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBooleanObj</h4> +<pre>public java.lang.Boolean adaptToBooleanObj(java.lang.Character value)</pre> +<div class="block">Adapts a character 'T' or 'F' to true or false. If <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBooleanObj(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>adaptToBooleanObj</h4> +<pre>public java.lang.Boolean adaptToBooleanObj(java.lang.String value)</pre> +<div class="block">Adapts a character "T" or "F" to true or false. If <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</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/TrueFalseAdapter.Adapter.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/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="TrueFalseAdapter.Adapter.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><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> diff --git a/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html new file mode 100644 index 0000000..d2f770e --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/TrueFalseAdapter.html @@ -0,0 +1,230 @@ +<!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>TrueFalseAdapter (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="TrueFalseAdapter (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/TrueFalseAdapter.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/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/TrueFalseAdapter.html" target="_top">Frames</a></li> +<li><a href="TrueFalseAdapter.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.adapter</div> +<h2 title="Annotation Type TrueFalseAdapter" class="title">Annotation Type TrueFalseAdapter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">@AdapterDefinition</a>(<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()">storageTypePreferences</a>={char.class,java.lang.Character.class,java.lang.String.class}) +public @interface <span class="strong">TrueFalseAdapter</span></pre> +<div class="block">Adapter that converts 'T' or 'F' to and from a boolean value. + + <p>Example:<pre> + public interface UserInfo extends Storable { + <b>@TrueFalseAdapter</b> + boolean isAdministrator(); + void setAdministrator(boolean admin); + + ... + } + </pre></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/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>YesNoAdapter</code></a>, +<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>AdapterDefinition</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html#lenient()">lenient</a></strong></code> +<div class="block">Specify that this adapter should be lenient when converting characters + into booleans.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="lenient()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>lenient</h4> +<pre>public abstract boolean lenient</pre> +<div class="block">Specify that this adapter should be lenient when converting characters + into booleans. By default it is true, and it accepts the following as + true: 'T', 't', 'Y', 'y', '1'. For false: 'F', 'f', 'N', 'n', '0'. When + lenient is false, only 'T' and 'F' are accepted.</div> +<dl> +<dt>Default:</dt> +<dd>true</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/TrueFalseAdapter.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/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/TrueFalseAdapter.html" target="_top">Frames</a></li> +<li><a href="TrueFalseAdapter.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html new file mode 100644 index 0000000..1481938 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html @@ -0,0 +1,470 @@ +<!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>YesNoAdapter.Adapter (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="YesNoAdapter.Adapter (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/YesNoAdapter.Adapter.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/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="YesNoAdapter.Adapter.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><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.adapter</div> +<h2 title="Class YesNoAdapter.Adapter" class="title">Class YesNoAdapter.Adapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.adapter.YesNoAdapter.Adapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">YesNoAdapter.Adapter</span> +extends java.lang.Object</pre> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>YesNoAdapter</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/adapter/YesNoAdapter.Adapter.html#YesNoAdapter.Adapter(java.lang.Class, java.lang.String, boolean)">YesNoAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + boolean lenient)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#YesNoAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.YesNoAdapter)">YesNoAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a> ann)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBoolean(char)">adaptToBoolean</a></strong>(char value)</code> +<div class="block">Adapts a character 'Y' or 'N' to true or false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBoolean(java.lang.Character)">adaptToBoolean</a></strong>(java.lang.Character value)</code> +<div class="block">Adapts a character 'Y' or 'N' to true or false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBoolean(java.lang.String)">adaptToBoolean</a></strong>(java.lang.String value)</code> +<div class="block">Adapts a character "Y" or "N" to true or false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBooleanObj(char)">adaptToBooleanObj</a></strong>(char value)</code> +<div class="block">Adapts a character 'Y' or 'N' to true or false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBooleanObj(java.lang.Character)">adaptToBooleanObj</a></strong>(java.lang.Character value)</code> +<div class="block">Adapts a character 'Y' or 'N' to true or false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBooleanObj(java.lang.String)">adaptToBooleanObj</a></strong>(java.lang.String value)</code> +<div class="block">Adapts a character "Y" or "N" to true or false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToChar(boolean)">adaptToChar</a></strong>(boolean value)</code> +<div class="block">Adapts a boolean true or false into 'Y' or 'N'.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToChar(java.lang.Boolean)">adaptToChar</a></strong>(java.lang.Boolean value)</code> +<div class="block">Adapts a boolean true into 'Y', and anything else to 'N'.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Character</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToCharacter(boolean)">adaptToCharacter</a></strong>(boolean value)</code> +<div class="block">Adapts a boolean true or false into 'Y' or 'N'.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Character</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToCharacter(java.lang.Boolean)">adaptToCharacter</a></strong>(java.lang.Boolean value)</code> +<div class="block">Adapts a boolean true into 'Y', and anything else to 'N'.</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/adapter/YesNoAdapter.Adapter.html#adaptToString(boolean)">adaptToString</a></strong>(boolean value)</code> +<div class="block">Adapts a boolean true or false into "Y" or "N".</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/adapter/YesNoAdapter.Adapter.html#adaptToString(java.lang.Boolean)">adaptToString</a></strong>(java.lang.Boolean value)</code> +<div class="block">Adapts a boolean true into "Y", and anything else to "N".</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> +</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="YesNoAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.YesNoAdapter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>YesNoAdapter.Adapter</h4> +<pre>public YesNoAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with adapter</dd><dd><code>ann</code> - specific annotation that binds to this adapter class</dd></dl> +</li> +</ul> +<a name="YesNoAdapter.Adapter(java.lang.Class, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>YesNoAdapter.Adapter</h4> +<pre>public YesNoAdapter.Adapter(java.lang.Class<?> type, + java.lang.String propertyName, + boolean lenient)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the adapted property</dd><dd><code>propertyName</code> - name of property with</dd><dd><code>lenient</code> - lenient when true</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="adaptToChar(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToChar</h4> +<pre>public char adaptToChar(boolean value)</pre> +<div class="block">Adapts a boolean true or false into 'Y' or 'N'.</div> +</li> +</ul> +<a name="adaptToChar(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToChar</h4> +<pre>public char adaptToChar(java.lang.Boolean value)</pre> +<div class="block">Adapts a boolean true into 'Y', and anything else to 'N'.</div> +</li> +</ul> +<a name="adaptToCharacter(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToCharacter</h4> +<pre>public java.lang.Character adaptToCharacter(boolean value)</pre> +<div class="block">Adapts a boolean true or false into 'Y' or 'N'.</div> +</li> +</ul> +<a name="adaptToCharacter(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToCharacter</h4> +<pre>public java.lang.Character adaptToCharacter(java.lang.Boolean value)</pre> +<div class="block">Adapts a boolean true into 'Y', and anything else to 'N'.</div> +</li> +</ul> +<a name="adaptToString(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(boolean value)</pre> +<div class="block">Adapts a boolean true or false into "Y" or "N".</div> +</li> +</ul> +<a name="adaptToString(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToString</h4> +<pre>public java.lang.String adaptToString(java.lang.Boolean value)</pre> +<div class="block">Adapts a boolean true into "Y", and anything else to "N".</div> +</li> +</ul> +<a name="adaptToBoolean(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBoolean</h4> +<pre>public boolean adaptToBoolean(char value)</pre> +<div class="block">Adapts a character 'Y' or 'N' to true or false. If <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBoolean(java.lang.Character)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBoolean</h4> +<pre>public boolean adaptToBoolean(java.lang.Character value)</pre> +<div class="block">Adapts a character 'Y' or 'N' to true or false. If <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBoolean(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBoolean</h4> +<pre>public boolean adaptToBoolean(java.lang.String value)</pre> +<div class="block">Adapts a character "Y" or "N" to true or false. If <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBooleanObj(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBooleanObj</h4> +<pre>public java.lang.Boolean adaptToBooleanObj(char value)</pre> +<div class="block">Adapts a character 'Y' or 'N' to true or false. If <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBooleanObj(java.lang.Character)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adaptToBooleanObj</h4> +<pre>public java.lang.Boolean adaptToBooleanObj(java.lang.Character value)</pre> +<div class="block">Adapts a character 'Y' or 'N' to true or false. If <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</li> +</ul> +<a name="adaptToBooleanObj(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>adaptToBooleanObj</h4> +<pre>public java.lang.Boolean adaptToBooleanObj(java.lang.String value)</pre> +<div class="block">Adapts a character "Y" or "N" to true or false. If <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html#lenient()"><code>lenient</code></a>, other characters are accepted as + well.</div> +</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/YesNoAdapter.Adapter.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/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="YesNoAdapter.Adapter.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><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> diff --git a/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html new file mode 100644 index 0000000..5022fcb --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/YesNoAdapter.html @@ -0,0 +1,230 @@ +<!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>YesNoAdapter (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="YesNoAdapter (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/YesNoAdapter.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/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/YesNoAdapter.html" target="_top">Frames</a></li> +<li><a href="YesNoAdapter.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.adapter</div> +<h2 title="Annotation Type YesNoAdapter" class="title">Annotation Type YesNoAdapter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">@AdapterDefinition</a>(<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()">storageTypePreferences</a>={char.class,java.lang.Character.class,java.lang.String.class}) +public @interface <span class="strong">YesNoAdapter</span></pre> +<div class="block">Adapter that converts 'Y' or 'N' to and from a boolean value. + + <p>Example:<pre> + public interface UserInfo extends Storable { + <b>@YesNoAdapter</b> + boolean isAdministrator(); + void setAdministrator(boolean admin); + + ... + } + </pre></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/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TrueFalseAdapter</code></a>, +<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>AdapterDefinition</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html#lenient()">lenient</a></strong></code> +<div class="block">Specify that this adapter should be lenient when converting characters + into booleans.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="lenient()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>lenient</h4> +<pre>public abstract boolean lenient</pre> +<div class="block">Specify that this adapter should be lenient when converting characters + into booleans. By default it is true, and it accepts the following as + true: 'Y', 'y', 'T', 't', '1'. For false: 'N', 'n', 'F', 'f', '0'. When + lenient is false, only 'Y' and 'N' are accepted.</div> +<dl> +<dt>Default:</dt> +<dd>true</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/YesNoAdapter.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/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/YesNoAdapter.html" target="_top">Frames</a></li> +<li><a href="YesNoAdapter.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/AdapterDefinition.html b/apidocs/com/amazon/carbonado/adapter/class-use/AdapterDefinition.html new file mode 100644 index 0000000..0d7254c --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/AdapterDefinition.html @@ -0,0 +1,185 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.AdapterDefinition (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="Uses of Class com.amazon.carbonado.adapter.AdapterDefinition (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><a href="../../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/AdapterDefinition.html" target="_top">Frames</a></li> +<li><a href="AdapterDefinition.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.AdapterDefinition" class="title">Uses of Class<br>com.amazon.carbonado.adapter.AdapterDefinition</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">AdapterDefinition</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">AdapterDefinition</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with annotations of type <a href="../../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">AdapterDefinition</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a></strong></code> +<div class="block">Converts Joda-Time datetime objects to and from other forms.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a></strong></code> +<div class="block">Allows arrays of primitive types to be encoded (big-endian) as byte arrays.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a></strong></code> +<div class="block">Converts database Blobs and Clobs to Strings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a></strong></code> +<div class="block">Adapter that converts 'T' or 'F' to and from a boolean value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a></strong></code> +<div class="block">Adapter that converts 'Y' or 'N' to and from a boolean value.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/AdapterDefinition.html" target="_top">Frames</a></li> +<li><a href="AdapterDefinition.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html new file mode 100644 index 0000000..81ed303 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter (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="Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter (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><a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="DateTimeAdapter.Adapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.DateTimeAdapter.Adapter</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.adapter.DateTimeAdapter.Adapter</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/DateTimeAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="DateTimeAdapter.Adapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html new file mode 100644 index 0000000..61ceae0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter (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="Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter (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><a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html" target="_top">Frames</a></li> +<li><a href="DateTimeAdapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.DateTimeAdapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.DateTimeAdapter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#DateTimeAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.DateTimeAdapter)">DateTimeAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html" target="_top">Frames</a></li> +<li><a href="DateTimeAdapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html new file mode 100644 index 0000000..a294541 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter (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="Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter (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><a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="PrimitiveArrayAdapter.Adapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="PrimitiveArrayAdapter.Adapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html new file mode 100644 index 0000000..4f87a6c --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter (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="Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter (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><a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html" target="_top">Frames</a></li> +<li><a href="PrimitiveArrayAdapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.PrimitiveArrayAdapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.PrimitiveArrayAdapter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#PrimitiveArrayAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.PrimitiveArrayAdapter)">PrimitiveArrayAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html" target="_top">Frames</a></li> +<li><a href="PrimitiveArrayAdapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html new file mode 100644 index 0000000..1358cde --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.TextAdapter.Adapter (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="Uses of Class com.amazon.carbonado.adapter.TextAdapter.Adapter (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><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="TextAdapter.Adapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.TextAdapter.Adapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.TextAdapter.Adapter</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.adapter.TextAdapter.Adapter</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/TextAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="TextAdapter.Adapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html new file mode 100644 index 0000000..498167d --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TextAdapter.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.TextAdapter (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="Uses of Class com.amazon.carbonado.adapter.TextAdapter (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><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/TextAdapter.html" target="_top">Frames</a></li> +<li><a href="TextAdapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.TextAdapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.TextAdapter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TextAdapter)">TextAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/TextAdapter.html" target="_top">Frames</a></li> +<li><a href="TextAdapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html new file mode 100644 index 0000000..47a502b --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter (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="Uses of Class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter (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><a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="TrueFalseAdapter.Adapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="TrueFalseAdapter.Adapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html new file mode 100644 index 0000000..eb1ae0e --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.TrueFalseAdapter (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="Uses of Class com.amazon.carbonado.adapter.TrueFalseAdapter (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><a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html" target="_top">Frames</a></li> +<li><a href="TrueFalseAdapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.TrueFalseAdapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.TrueFalseAdapter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TrueFalseAdapter)">TrueFalseAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html" target="_top">Frames</a></li> +<li><a href="TrueFalseAdapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html new file mode 100644 index 0000000..f35572f --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.YesNoAdapter.Adapter (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="Uses of Class com.amazon.carbonado.adapter.YesNoAdapter.Adapter (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><a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="YesNoAdapter.Adapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.YesNoAdapter.Adapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.YesNoAdapter.Adapter</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.adapter.YesNoAdapter.Adapter</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/YesNoAdapter.Adapter.html" target="_top">Frames</a></li> +<li><a href="YesNoAdapter.Adapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.html b/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.html new file mode 100644 index 0000000..bac79d1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/class-use/YesNoAdapter.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.adapter.YesNoAdapter (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="Uses of Class com.amazon.carbonado.adapter.YesNoAdapter (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><a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/YesNoAdapter.html" target="_top">Frames</a></li> +<li><a href="YesNoAdapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.adapter.YesNoAdapter" class="title">Uses of Class<br>com.amazon.carbonado.adapter.YesNoAdapter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#YesNoAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.YesNoAdapter)">YesNoAdapter.Adapter</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/adapter/class-use/YesNoAdapter.html" target="_top">Frames</a></li> +<li><a href="YesNoAdapter.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> diff --git a/apidocs/com/amazon/carbonado/adapter/package-frame.html b/apidocs/com/amazon/carbonado/adapter/package-frame.html new file mode 100644 index 0000000..2bb220a --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-frame.html @@ -0,0 +1,33 @@ +<!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.adapter (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/adapter/package-summary.html" target="classFrame">com.amazon.carbonado.adapter</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter" target="classFrame">DateTimeAdapter.Adapter</a></li> +<li><a href="PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter" target="classFrame">PrimitiveArrayAdapter.Adapter</a></li> +<li><a href="TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter" target="classFrame">TextAdapter.Adapter</a></li> +<li><a href="TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter" target="classFrame">TrueFalseAdapter.Adapter</a></li> +<li><a href="YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter" target="classFrame">YesNoAdapter.Adapter</a></li> +</ul> +<h2 title="Annotation Types">Annotation Types</h2> +<ul title="Annotation Types"> +<li><a href="AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter" target="classFrame">AdapterDefinition</a></li> +<li><a href="DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter" target="classFrame">DateTimeAdapter</a></li> +<li><a href="PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter" target="classFrame">PrimitiveArrayAdapter</a></li> +<li><a href="TextAdapter.html" title="annotation in com.amazon.carbonado.adapter" target="classFrame">TextAdapter</a></li> +<li><a href="TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter" target="classFrame">TrueFalseAdapter</a></li> +<li><a href="YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter" target="classFrame">YesNoAdapter</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/adapter/package-summary.html b/apidocs/com/amazon/carbonado/adapter/package-summary.html new file mode 100644 index 0000000..1277e21 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-summary.html @@ -0,0 +1,219 @@ +<!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.adapter (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.adapter (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><a href="../../../../com/amazon/carbonado/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/capability/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/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.adapter</h1> +<div class="docSummary"> +<div class="block">Contains annotations and implementations for supporting property adapters.</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="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/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></td> +<td class="colLast"> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>DateTimeAdapter</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></td> +<td class="colLast"> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>PrimitiveArrayAdapter</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></td> +<td class="colLast"> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TextAdapter</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></td> +<td class="colLast"> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TrueFalseAdapter</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></td> +<td class="colLast"> +<div class="block">Adapter implementation for <a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>YesNoAdapter</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/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter">AdapterDefinition</a></td> +<td class="colLast"> +<div class="block">Allows annotations to be defined for supporting property types which are not + natively supported by the underlying storage layer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter">DateTimeAdapter</a></td> +<td class="colLast"> +<div class="block">Converts Joda-Time datetime objects to and from other forms.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a></td> +<td class="colLast"> +<div class="block">Allows arrays of primitive types to be encoded (big-endian) as byte arrays.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter">TextAdapter</a></td> +<td class="colLast"> +<div class="block">Converts database Blobs and Clobs to Strings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter">TrueFalseAdapter</a></td> +<td class="colLast"> +<div class="block">Adapter that converts 'T' or 'F' to and from a boolean value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter">YesNoAdapter</a></td> +<td class="colLast"> +<div class="block">Adapter that converts 'Y' or 'N' to and from a boolean value.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.adapter Description">Package com.amazon.carbonado.adapter Description</h2> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>AdapterDefinition</code></a></dd></dl> +</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><a href="../../../../com/amazon/carbonado/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/capability/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/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> diff --git a/apidocs/com/amazon/carbonado/adapter/package-tree.html b/apidocs/com/amazon/carbonado/adapter/package-tree.html new file mode 100644 index 0000000..ae1b8a9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-tree.html @@ -0,0 +1,143 @@ +<!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.adapter Class Hierarchy (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.adapter Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/capability/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.adapter</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">DateTimeAdapter.Adapter</span></a></li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">PrimitiveArrayAdapter.Adapter</span></a></li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">TextAdapter.Adapter</span></a></li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">TrueFalseAdapter.Adapter</span></a></li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">YesNoAdapter.Adapter</span></a></li> +</ul> +</li> +</ul> +<h2 title="Annotation Type Hierarchy">Annotation Type Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">TrueFalseAdapter</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">AdapterDefinition</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">YesNoAdapter</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">DateTimeAdapter</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">PrimitiveArrayAdapter</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.adapter.<a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">TextAdapter</span></a> (implements java.lang.annotation.Annotation)</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/capability/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/adapter/package-use.html b/apidocs/com/amazon/carbonado/adapter/package-use.html new file mode 100644 index 0000000..5cbc4db --- /dev/null +++ b/apidocs/com/amazon/carbonado/adapter/package-use.html @@ -0,0 +1,180 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.adapter (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="Uses of Package com.amazon.carbonado.adapter (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.adapter" class="title">Uses of Package<br>com.amazon.carbonado.adapter</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> used by <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/adapter/class-use/AdapterDefinition.html#com.amazon.carbonado.adapter">AdapterDefinition</a> +<div class="block">Allows annotations to be defined for supporting property types which are not + natively supported by the underlying storage layer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/adapter/class-use/DateTimeAdapter.html#com.amazon.carbonado.adapter">DateTimeAdapter</a> +<div class="block">Converts Joda-Time datetime objects to and from other forms.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/adapter/class-use/PrimitiveArrayAdapter.html#com.amazon.carbonado.adapter">PrimitiveArrayAdapter</a> +<div class="block">Allows arrays of primitive types to be encoded (big-endian) as byte arrays.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/adapter/class-use/TextAdapter.html#com.amazon.carbonado.adapter">TextAdapter</a> +<div class="block">Converts database Blobs and Clobs to Strings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/adapter/class-use/TrueFalseAdapter.html#com.amazon.carbonado.adapter">TrueFalseAdapter</a> +<div class="block">Adapter that converts 'T' or 'F' to and from a boolean value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/adapter/class-use/YesNoAdapter.html#com.amazon.carbonado.adapter">YesNoAdapter</a> +<div class="block">Adapter that converts 'Y' or 'N' to and from a boolean value.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/adapter/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/capability/Capability.html b/apidocs/com/amazon/carbonado/capability/Capability.html new file mode 100644 index 0000000..ad1e7db --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/Capability.html @@ -0,0 +1,172 @@ +<!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>Capability (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="Capability (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/Capability.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/Capability.html" target="_top">Frames</a></li> +<li><a href="Capability.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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.capability</div> +<h2 title="Interface Capability" class="title">Interface Capability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a>, <a href="../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability</a>, <a href="../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a>, <a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">GroupAccessCapability</a>, <a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a>, <a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessCapability</a>, <a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">IndexInfoCapability</a>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S>, <a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a>, <a href="../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">LogAccessCapability</a>, <a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">RemoteProcedureCapability</a>, <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a>, <a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a>, <a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a>, <a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a>, <a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">TriggerManagerCapability</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a>, <a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Capability</span></pre> +<div class="block">Marker interface for identifying extra repository capabilities.</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/Repository.html#getCapability(java.lang.Class)"><code>Repository.getCapability(java.lang.Class<C>)</code></a></dd></dl> +</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/Capability.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/Capability.html" target="_top">Frames</a></li> +<li><a href="Capability.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html b/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html new file mode 100644 index 0000000..93d18e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html @@ -0,0 +1,220 @@ +<!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>GroupAccessCapability (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="GroupAccessCapability (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/GroupAccessCapability.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/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/GroupAccessCapability.html" target="_top">Frames</a></li> +<li><a href="GroupAccessCapability.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.capability</div> +<h2 title="Interface GroupAccessCapability" class="title">Interface GroupAccessCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">GroupAccessCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for gaining access to replication group members.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Vishal Parakh</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><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html#getGroupMembers()">getGroupMembers</a></strong>()</code> +<div class="block">Return all replication group members, including this repository.</div> +</td> +</tr> +</table> +</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="getGroupMembers()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getGroupMembers</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a> getGroupMembers()</pre> +<div class="block">Return all replication group members, including this repository. + Returned instance remains the same unless group membership changes.</div> +</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/GroupAccessCapability.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/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/GroupAccessCapability.html" target="_top">Frames</a></li> +<li><a href="GroupAccessCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/GroupMembers.html b/apidocs/com/amazon/carbonado/capability/GroupMembers.html new file mode 100644 index 0000000..e0b5336 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/GroupMembers.html @@ -0,0 +1,215 @@ +<!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>GroupMembers (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="GroupMembers (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/GroupMembers.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/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/GroupMembers.html" target="_top">Frames</a></li> +<li><a href="GroupMembers.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.capability</div> +<h2 title="Interface GroupMembers" class="title">Interface GroupMembers</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">GroupMembers</span></pre> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Vishal Parakh, 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>java.util.SortedMap<java.lang.Object,<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html#getReadWriteMembers()">getReadWriteMembers</a></strong>()</code> +<div class="block">Returns members intended for read and write access.</div> +</td> +</tr> +</table> +</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="getReadWriteMembers()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getReadWriteMembers</h4> +<pre>java.util.SortedMap<java.lang.Object,<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> getReadWriteMembers()</pre> +<div class="block">Returns members intended for read and write access. Keys must uniquely + identify group members, must be serializable, and must have appropriate + implementations of the hashCode and equals methods.</div> +</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/GroupMembers.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/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/GroupMembers.html" target="_top">Frames</a></li> +<li><a href="GroupMembers.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> diff --git a/apidocs/com/amazon/carbonado/capability/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/IndexInfo.html new file mode 100644 index 0000000..28f8e06 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/IndexInfo.html @@ -0,0 +1,294 @@ +<!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>IndexInfo (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="IndexInfo (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/IndexInfo.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/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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.capability</div> +<h2 title="Interface IndexInfo" class="title">Interface IndexInfo</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IndexInfo</span></pre> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>. + + <p>IndexInfo instances are thread-safe and immutable.</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/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a></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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of this index, or null if not applicable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns the directions of all the properties in this index.</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/capability/IndexInfo.html#getPropertyNames()">getPropertyNames</a></strong>()</code> +<div class="block">Returns the properties in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">isClustered</a></strong>()</code> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">isUnique</a></strong>()</code> +<div class="block">Returns true if index entries are unique.</div> +</td> +</tr> +</table> +</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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of this index, or null if not applicable.</div> +</li> +</ul> +<a name="isUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUnique</h4> +<pre>boolean isUnique()</pre> +<div class="block">Returns true if index entries are unique.</div> +</li> +</ul> +<a name="isClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClustered</h4> +<pre>boolean isClustered()</pre> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +</li> +</ul> +<a name="getPropertyNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyNames</h4> +<pre>java.lang.String[] getPropertyNames()</pre> +<div class="block">Returns the properties in this index. The array might be empty, but it + is never null. The array is a copy, and so it may be safely modified.</div> +</li> +</ul> +<a name="getPropertyDirections()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPropertyDirections</h4> +<pre><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] getPropertyDirections()</pre> +<div class="block">Returns the directions of all the properties in this index. The length + of the array matches the length returned by <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()"><code>getPropertyNames()</code></a>. The array is a copy, and so it may be safely + modified.</div> +</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/IndexInfo.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/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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> diff --git a/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html b/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html new file mode 100644 index 0000000..2e416fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html @@ -0,0 +1,225 @@ +<!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>IndexInfoCapability (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="IndexInfoCapability (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/IndexInfoCapability.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/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/IndexInfoCapability.html" target="_top">Frames</a></li> +<li><a href="IndexInfoCapability.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.capability</div> +<h2 title="Interface IndexInfoCapability" class="title">Interface IndexInfoCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IndexInfoCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for getting information about physical indexes for storables.</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><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</td> +</tr> +</table> +</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="getIndexInfo(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getIndexInfo</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[] getIndexInfo(java.lang.Class<S> storableType) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns information about the known indexes for the given storable + type. The array might be empty, but it is never null. The array is a + copy, and so it may be safely modified.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/IndexInfoCapability.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/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/IndexInfoCapability.html" target="_top">Frames</a></li> +<li><a href="IndexInfoCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html new file mode 100644 index 0000000..f4dd965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html @@ -0,0 +1,383 @@ +<!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>RemoteProcedure.Call (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="RemoteProcedure.Call (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/RemoteProcedure.Call.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/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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.capability</div> +<h2 title="Interface RemoteProcedure.Call" class="title">Interface RemoteProcedure.Call<R,D></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd></dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">RemoteProcedure.Call<R,D></span></pre> +<div class="block">Client-side call into a remote procedure. To avoid leaking resources, + the finish method must be invoked or all reply data be fully read. If an + exception is thrown by a method defined in this interface, resources are + automatically released.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)"><code>RemoteProcedureCapability.beginCall(com.amazon.carbonado.capability.RemoteProcedure<R, D>)</code></a></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/capability/RemoteProcedure.Call.html#execute()">execute</a></strong>()</code> +<div class="block">Executes the call without expecting a reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#executeAsync()">executeAsync</a></strong>()</code> +<div class="block">Executes the call without expecting a reply.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#fetchReply()">fetchReply</a></strong>()</code> +<div class="block">Executes the call and receive a reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#flush()">flush</a></strong>()</code> +<div class="block">Flushes all the data sent so far.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#send(D)">send</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data)</code> +<div class="block">Send data to the remote procedure.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor)</code> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable)</code> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +</td> +</tr> +</table> +</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="send(java.lang.Object)"> +<!-- --> +</a><a name="send(D)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>send</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> send(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send data to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> sendAll(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> sendAll(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if data is null</dd> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> reset() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Call instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="flush()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flush</h4> +<pre>void flush() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Flushes all the data sent so far. Flush is invoked automatically + when call is executed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="fetchReply()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchReply</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>> fetchReply() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call and receive a reply. Calling this method does not + block, but methods on the returned Cursor may block waiting for + data.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="execute()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>void execute() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call without expecting a reply. Method blocks waiting + for procedure to finish.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="executeAsync()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executeAsync</h4> +<pre>void executeAsync() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Executes the call without expecting a reply. Method does not block + waiting for procedure to finish. Asynchronous execution is not + allowed if the current thread is in a transaction. This is because + transaction ownership becomes ambiguous.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a call has been executed or if + current thread is in a transaction</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/RemoteProcedure.Call.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/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html new file mode 100644 index 0000000..5f140a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html @@ -0,0 +1,330 @@ +<!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>RemoteProcedure.Reply (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="RemoteProcedure.Reply (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/RemoteProcedure.Reply.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/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Reply.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Reply.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.capability</div> +<h2 title="Interface RemoteProcedure.Reply" class="title">Interface RemoteProcedure.Reply<R></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd></dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">RemoteProcedure.Reply<R></span></pre> +<div class="block">Reply from remote procedure implementation. To avoid leaking resources, + the finish method must always be invoked. If an exception is thrown by a + method defined in this interface, resources are automatically released.</div> +</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/capability/RemoteProcedure.Reply.html#finish()">finish</a></strong>()</code> +<div class="block">Finish the reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#flush()">flush</a></strong>()</code> +<div class="block">Flushes all the data sent so far.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the reply, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#send(R)">send</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a> data)</code> +<div class="block">Send reply data to the caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> cursor)</code> +<div class="block">Reply with all data from the given cursor to the caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> iterable)</code> +<div class="block">Reply with all data from the given iterable to the caller.</div> +</td> +</tr> +</table> +</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="send(java.lang.Object)"> +<!-- --> +</a><a name="send(R)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>send</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> send(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a> data) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Send reply data to the caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Reply instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply is finished</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> sendAll(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> iterable) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reply with all data from the given iterable to the caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Reply instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply is finished</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="sendAll(com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sendAll</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> sendAll(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> cursor) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reply with all data from the given cursor to the caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Reply instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply is finished</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> reset() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reset the internal object stream of the reply, allowing cached + objects to get freed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>this Reply instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply is finished</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="flush()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flush</h4> +<pre>void flush() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Flushes all the data sent so far. Flush is invoked automatically + when reply is finished.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="finish()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>finish</h4> +<pre>void finish() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Finish the reply.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/RemoteProcedure.Reply.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/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Reply.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Reply.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> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html new file mode 100644 index 0000000..04a63b8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html @@ -0,0 +1,288 @@ +<!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>RemoteProcedure.Request (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="RemoteProcedure.Request (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/RemoteProcedure.Request.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/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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.capability</div> +<h2 title="Interface RemoteProcedure.Request" class="title">Interface RemoteProcedure.Request<R,D></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd></dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">RemoteProcedure.Request<R,D></span></pre> +<div class="block">Request into a remote procedure, as seen by procedure implementation. To + avoid leaking resources, the request or reply object must always be + finished. If an exception is thrown by a method defined in this + interface, resources are automatically released.</div> +</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><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#beginReply()">beginReply</a></strong>()</code> +<div class="block">Begin a reply after receiving all data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#finish()">finish</a></strong>()</code> +<div class="block">Reply and immediately finish, without sending any data to caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receive()">receive</a></strong>()</code> +<div class="block">Receive data from caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receiveInto(java.util.Collection)">receiveInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>> c)</code> +<div class="block">Receive all remaining data from caller.</div> +</td> +</tr> +</table> +</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="receive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>receive</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a> receive() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Receive data from caller.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no more data</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="receiveInto(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>receiveInto</h4> +<pre>int receiveInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>> c) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Receive all remaining data from caller.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - collection to receive data</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount received</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="beginReply()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beginReply</h4> +<pre><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>> beginReply() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Begin a reply after receiving all data. If no data is expected, + reply can be made without calling receive.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if reply was already begun, or if + request is finished, or if more data must be received</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="finish()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>finish</h4> +<pre>void finish() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Reply and immediately finish, without sending any data to caller.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a reply was already begun or if + more data must be received</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/RemoteProcedure.Request.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/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html new file mode 100644 index 0000000..4b64cbb --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html @@ -0,0 +1,268 @@ +<!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>RemoteProcedure (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="RemoteProcedure (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/RemoteProcedure.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/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.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>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.capability</div> +<h2 title="Interface RemoteProcedure" class="title">Interface RemoteProcedure<R,D></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd></dl> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">RemoteProcedure<R,D></span> +extends java.io.Serializable</pre> +<div class="block">Defines a remote procedure which can be executed by <a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedureCapability</code></a>. Any data within the procedure instance is + serialized to the remote host, and possibly the class definition + too. Execution might have security restrictions applied. + + <p>The RemoteProcedure instance is Serializable, and so any serializable + parameters can be passed with it. Storables and extra data can be sent + through the <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedure.Request</code></a> object. Any data returned by procedure + implementation must be sent through the <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedure.Reply</code></a> object.</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"> +<!-- ======== 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">Interface 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/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></strong></code> +<div class="block">Client-side call into a remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></strong></code> +<div class="block">Reply from remote procedure implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>></strong></code> +<div class="block">Request into a remote procedure, as seen by procedure implementation.</div> +</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html#handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)">handleRequest</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> request)</code> +<div class="block">Request handler for remote procedure implementation.</div> +</td> +</tr> +</table> +</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="handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>handleRequest</h4> +<pre>boolean handleRequest(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> request) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Request handler for remote procedure implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - repository as seen by host that procedure is running from</dd><dd><code>request</code> - non-null request object</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if request is still active when this method returns; + request must eventually be explicitly finished</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/RemoteProcedure.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/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedure.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.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>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> diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html new file mode 100644 index 0000000..141e802 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html @@ -0,0 +1,237 @@ +<!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>RemoteProcedureCapability (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="RemoteProcedureCapability (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/RemoteProcedureCapability.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/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedureCapability.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedureCapability.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.capability</div> +<h2 title="Interface RemoteProcedureCapability" class="title">Interface RemoteProcedureCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">RemoteProcedureCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability which allows arbitrary code to run on a remote host and access + its repository. The remote procedure might have security restrictions + applied to it. + + <p>Examples:<pre> + RemoteProcedureCapability cap = ... + Cursor<MyRecord> c1 = cap.beginCall(new CustomQuery<MyRecord>(params)).fetchReply(); + ... + + Cursor<InputRecord> c2 = ... + cap.beginCall(new Importer<InputRecord>()).sendAll(c2).finish(); + </pre></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/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedure</code></a></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><R,D> <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)">beginCall</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc)</code> +<div class="block">Begins a call to execute the given procedure on a remote host.</div> +</td> +</tr> +</table> +</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="beginCall(com.amazon.carbonado.capability.RemoteProcedure)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>beginCall</h4> +<pre><R,D> <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D> beginCall(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Begins a call to execute the given procedure on a remote host. + Execution commences when the Call object is instructed to do so.</div> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>R</code> - reply object type</dd><dd><code>D</code> - request data object type</dd><dt><span class="strong">Parameters:</span></dt><dd><code>proc</code> - procedure to execute</dd> +<dt><span class="strong">Returns:</span></dt><dd>object for defining the call and receiving a reply</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/RemoteProcedureCapability.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/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/RemoteProcedureCapability.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedureCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html b/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html new file mode 100644 index 0000000..b82045d --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html @@ -0,0 +1,561 @@ +<!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>ResyncCapability.Listener (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="ResyncCapability.Listener (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/ResyncCapability.Listener.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/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ResyncCapability.Listener.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.Listener.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_classes_inherited_from_class_com.amazon.carbonado.Trigger">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.capability</div> +<h2 title="Class ResyncCapability.Listener" class="title">Class ResyncCapability.Listener<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">com.amazon.carbonado.Trigger</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.capability.ResyncCapability.Listener<S></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">ResyncCapability.Listener<S></span> +extends <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></pre> +<div class="block">Trigger which is invoked as storables get re-sync'd. Callbacks are + invoked in the scope of the resync transaction. If any unchecked + exception is thrown, the immediate changes are rolled back and the + entire repository resync operation is aborted. + + <p>The listener implementation should return quickly from the callback + methods, to avoid lingering transactions. If the listener is used to + invoke special repair operations, they should be placed into a task + queue. A separate thread can then perform the repairs outside the resync + transaction.</div> +</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.Trigger"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></h3> +<code><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></code></li> +</ul> +</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/capability/ResyncCapability.Listener.html#ResyncCapability.Listener()">ResyncCapability.Listener</a></strong>()</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterDelete(S, java.lang.Object)">afterDelete</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state)</code> +<div class="block">Called right after a bogus storable has been successfully deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterInsert(S, java.lang.Object)">afterInsert</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called right after a sync'd storable has been successfully inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called right after a sync'd storable has been successfully updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeDelete(S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable)</code> +<div class="block">Called before a bogus storable is to be deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeInsert(S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Called before a sync'd storable is to be inserted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeUpdate(S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Called before a sync'd storable is to be updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeUpdate(S, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedDelete(S, java.lang.Object)">failedDelete</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state)</code> +<div class="block">Called when a delete operation failed because an exception was + thrown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedInsert(S, java.lang.Object)">failedInsert</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called when an insert operation failed because an exception was + thrown.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called when an update operation failed because an exception was + thrown.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Trigger"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></h3> +<code><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()">abortTry</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#afterLoad(S)">afterLoad</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">beforeTryDelete</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">beforeTryInsert</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">beforeTryUpdate</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a>, <a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></code></li> +</ul> +<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> +</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="ResyncCapability.Listener()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ResyncCapability.Listener</h4> +<pre>public ResyncCapability.Listener()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="beforeInsert(java.lang.Object)"> +<!-- --> +</a><a name="beforeInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeInsert</h4> +<pre>public java.lang.Object beforeInsert(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a sync'd storable is to be inserted. Changes can be + made to the storable at this point, possibly to define independent + properties.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)">beforeInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterInsert or failedInsert method</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="afterInsert(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterInsert</h4> +<pre>public void afterInsert(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a sync'd storable has been successfully inserted.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">afterInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable after being inserted</dd><dd><code>state</code> - object returned by beforeInsert method</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="failedInsert(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedInsert</h4> +<pre>public void failedInsert(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</pre> +<div class="block">Called when an insert operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedInsert(S, java.lang.Object)">failedInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable which failed to be inserted</dd><dd><code>state</code> - object returned by beforeInsert method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeUpdate(java.lang.Object)"> +<!-- --> +</a><a name="beforeUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a sync'd storable is to be updated. Changes can be + made to the storable at this point, possibly to update independent + properties.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">beforeUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterUpdate or failedUpdate method</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="beforeUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="beforeUpdate(S, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states. Changes can be made + to the storable at this point, possibly to update independent + properties. + + <p>The default implementation calls the single argument beforeUpdate + method, only passing the newly sync'd storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oldStorable</code> - storable prior to being sync'd</dd><dd><code>newStorable</code> - sync'd storable before being updated</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="afterUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterUpdate</h4> +<pre>public void afterUpdate(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a sync'd storable has been successfully updated.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable after being updated</dd><dd><code>state</code> - optional object returned by beforeUpdate method</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="failedUpdate(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedUpdate</h4> +<pre>public void failedUpdate(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</pre> +<div class="block">Called when an update operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>newStorable</code> - sync'd storable which failed to be updated</dd><dd><code>state</code> - object returned by beforeUpdate method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeDelete(java.lang.Object)"> +<!-- --> +</a><a name="beforeDelete(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeDelete</h4> +<pre>public java.lang.Object beforeDelete(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called before a bogus storable is to be deleted.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)">beforeDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>oldStorable</code> - bogus storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterDelete or failedDelete method</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="afterDelete(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="afterDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterDelete</h4> +<pre>public void afterDelete(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Called right after a bogus storable has been successfully deleted.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">afterDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>oldStorable</code> - bogus storable after being deleted</dd><dd><code>state</code> - optional object returned by beforeDelete method</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="failedDelete(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="failedDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>failedDelete</h4> +<pre>public void failedDelete(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state)</pre> +<div class="block">Called when a delete operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedDelete(S, java.lang.Object)">failedDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>oldStorable</code> - bogus storable which failed to be deleted</dd><dd><code>state</code> - object returned by beforeDelete method, but it may be null</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/ResyncCapability.Listener.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/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ResyncCapability.Listener.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.Listener.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_classes_inherited_from_class_com.amazon.carbonado.Trigger">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> diff --git a/apidocs/com/amazon/carbonado/capability/ResyncCapability.html b/apidocs/com/amazon/carbonado/capability/ResyncCapability.html new file mode 100644 index 0000000..9233805 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ResyncCapability.html @@ -0,0 +1,300 @@ +<!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>ResyncCapability (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="ResyncCapability (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/ResyncCapability.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/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ResyncCapability.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.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>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.capability</div> +<h2 title="Interface ResyncCapability" class="title">Interface ResyncCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ResyncCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability of replicating repositories for re-synchronizing to the master + repository. A re-sync operation can be used to fill up a fresh replication + repository or to repair inconsistencies.</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"> +<!-- ======== 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">Interface and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>></strong></code> +<div class="block">Trigger which is invoked as storables get re-sync'd.</div> +</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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#getMasterRepository()">getMasterRepository</a></strong>()</code> +<div class="block">Returns the immediate master Repository, for manual comparison.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +</table> +</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="resync(java.lang.Class, double, java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resync</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> void resync(java.lang.Class<S> type, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to re-sync</dd><dd><code>desiredSpeed</code> - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc</dd><dd><code>filter</code> - optional query filter to limit which objects get re-sync'ed</dd><dd><code>filterValues</code> - filter values for optional filter</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resync</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> void resync(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to re-sync</dd><dd><code>listener</code> - optional listener which gets notified as storables are re-sync'd</dd><dd><code>desiredSpeed</code> - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc</dd><dd><code>filter</code> - optional query filter to limit which objects get re-sync'ed</dd><dd><code>filterValues</code> - filter values for optional filter</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getMasterRepository()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMasterRepository</h4> +<pre><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> getMasterRepository()</pre> +<div class="block">Returns the immediate master Repository, for manual comparison. Direct + updates to the master will likely create inconsistencies.</div> +</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/ResyncCapability.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/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ResyncCapability.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.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>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> diff --git a/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html new file mode 100644 index 0000000..278f1da --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html @@ -0,0 +1,277 @@ +<!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>ShutdownCapability (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="ShutdownCapability (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/ShutdownCapability.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/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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.capability</div> +<h2 title="Interface ShutdownCapability" class="title">Interface ShutdownCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ShutdownCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">isAutoShutdownEnabled</a></strong>()</code> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled</a></strong>(boolean enabled)</code> +<div class="block">Request to enable or disable the automatic shutdown hook.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#shutdown()">shutdown</a></strong>()</code> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.</div> +</td> +</tr> +</table> +</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="isAutoShutdownEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutoShutdownEnabled</h4> +<pre>boolean isAutoShutdownEnabled()</pre> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</li> +</ul> +<a name="setAutoShutdownEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoShutdownEnabled</h4> +<pre>void setAutoShutdownEnabled(boolean enabled)</pre> +<div class="block">Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.SecurityException</code> - if caller does not have permission</dd></dl> +</li> +</ul> +<a name="shutdown()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>void shutdown()</pre> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down. Calling + close may cause spurious exceptions to be thrown by other threads which + may be interacting with the repository. Shutdown tries to reduce these + exceptions from being thrown by effectively <i>suspending</i> any + threads which continue to interact with this repository. <b>For this + reason, this method should only ever be called during a virtual machine + shutdown.</b> + + <p>Repositories may choose to implement this method by simply calling + close. There is no guarantee that shutdown will reduce exceptions, and + it might not suspend any threads. Also, repositories that require proper + shutdown should automatically register runtime hooks, and so this method + usually doesn't need to be called manually.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.SecurityException</code> - if caller does not have permission</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/ShutdownCapability.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/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html new file mode 100644 index 0000000..2e7263e --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html @@ -0,0 +1,265 @@ +<!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>StorableInfoCapability (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="StorableInfoCapability (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/StorableInfoCapability.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/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/StorableInfoCapability.html" target="_top">Frames</a></li> +<li><a href="StorableInfoCapability.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.capability</div> +<h2 title="Interface StorableInfoCapability" class="title">Interface StorableInfoCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableInfoCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability that returns information about known storable types in a + repository.</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>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#getUserStorableTypeNames()">getUserStorableTypeNames</a></strong>()</code> +<div class="block">Returns an array of storable type class names for user-level storables + known to the repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#isPropertySupported(java.lang.Class, java.lang.String)">isPropertySupported</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + java.lang.String name)</code> +<div class="block">Returns true if the given property exists and is supported.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#isSupported(java.lang.Class)">isSupported</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns true if the given storable type is supported.</div> +</td> +</tr> +</table> +</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="getUserStorableTypeNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserStorableTypeNames</h4> +<pre>java.lang.String[] getUserStorableTypeNames() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns an array of storable type class names for user-level storables + known to the repository. The array might be empty, but it is never + null. The array is a copy, and so it may be safely modified. + <p> + This method returns class names instead of class instances because the + repository may not be able to load the classes.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="isSupported(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSupported</h4> +<pre>boolean isSupported(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<div class="block">Returns true if the given storable type is supported.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - storable type to examine</dd></dl> +</li> +</ul> +<a name="isPropertySupported(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isPropertySupported</h4> +<pre>boolean isPropertySupported(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + java.lang.String name)</pre> +<div class="block">Returns true if the given property exists and is supported.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - storable type to examine</dd><dd><code>name</code> - name of property to examine</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/StorableInfoCapability.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/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/StorableInfoCapability.html" target="_top">Frames</a></li> +<li><a href="StorableInfoCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/Capability.html b/apidocs/com/amazon/carbonado/capability/class-use/Capability.html new file mode 100644 index 0000000..a55397f --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/Capability.html @@ -0,0 +1,478 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.Capability (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="Uses of Interface com.amazon.carbonado.capability.Capability (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><a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/Capability.html" target="_top">Frames</a></li> +<li><a href="Capability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.Capability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.Capability</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with type parameters of type <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><C extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> <br>C</code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)">getCapability</a></strong>(java.lang.Class<C> capabilityType)</code> +<div class="block">Requests a specific capability of this Repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">GroupAccessCapability</a></strong></code> +<div class="block">Capability for gaining access to replication group members.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">IndexInfoCapability</a></strong></code> +<div class="block">Capability for getting information about physical indexes for storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">RemoteProcedureCapability</a></strong></code> +<div class="block">Capability which allows arbitrary code to run on a remote host and access + its repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></strong></code> +<div class="block">Capability of replicating repositories for re-synchronizing to the master + repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></strong></code> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></strong></code> +<div class="block">Capability that returns information about known storable types in a + repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></strong></code> +<div class="block">Capability to get layout information on any storable generation.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that implement <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></strong></code> +<div class="block">Factory for obtaining references to storable layouts.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessCapability</a></strong></code> +<div class="block">Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></strong></code> +<div class="block">Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">LogAccessCapability</a></strong></code> +<div class="block">Provides access to the Log.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a></strong></code> +<div class="block">Capability to control BDB checkpointing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability</a></strong></code> +<div class="block">Capability to compact a BDB database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></strong></code> +<div class="block">Capability to provide direct access to the underlying BDB environment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a></strong></code> +<div class="block">Capability for performing a backup of an active BDB environment.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></strong></code> +<div class="block">Capability to use sequences.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">TriggerManagerCapability</a></strong></code> +<div class="block">Provides the capability to get the <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> from a <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a><Txn></strong></code> +<div class="block">Implements basic functionality required by a core Repository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with type parameters of type <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><C extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> <br>C</code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html#getCapability(java.lang.Class)">getCapability</a></strong>(java.lang.Class<C> capabilityType)</code> +<div class="block">Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/Capability.html" target="_top">Frames</a></li> +<li><a href="Capability.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html new file mode 100644 index 0000000..ae015ef --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.GroupAccessCapability (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="Uses of Interface com.amazon.carbonado.capability.GroupAccessCapability (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><a href="../../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/GroupAccessCapability.html" target="_top">Frames</a></li> +<li><a href="GroupAccessCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.GroupAccessCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.GroupAccessCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.GroupAccessCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/GroupAccessCapability.html" target="_top">Frames</a></li> +<li><a href="GroupAccessCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html b/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html new file mode 100644 index 0000000..e329c4f --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.GroupMembers (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="Uses of Interface com.amazon.carbonado.capability.GroupMembers (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><a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/GroupMembers.html" target="_top">Frames</a></li> +<li><a href="GroupMembers.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.GroupMembers" class="title">Uses of Interface<br>com.amazon.carbonado.capability.GroupMembers</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></code></td> +<td class="colLast"><span class="strong">GroupAccessCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/GroupAccessCapability.html#getGroupMembers()">getGroupMembers</a></strong>()</code> +<div class="block">Return all replication group members, including this repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/GroupMembers.html" target="_top">Frames</a></li> +<li><a href="GroupMembers.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html new file mode 100644 index 0000000..08d3155 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html @@ -0,0 +1,266 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.IndexInfo (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="Uses of Interface com.amazon.carbonado.capability.IndexInfo (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><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.IndexInfo" class="title">Uses of Interface<br>com.amazon.carbonado.capability.IndexInfo</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfoCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(java.lang.Class, com.amazon.carbonado.capability.IndexInfo)">StorableIndex</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> type, + <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> indexInfo)</code> +<div class="block">Creates a StorableIndex from an IndexInfo.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><span class="strong">JDBCStorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIndexInfo()">getIndexInfo</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></strong></code> +<div class="block">Basic implementation of an <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html new file mode 100644 index 0000000..e461469 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.IndexInfoCapability (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="Uses of Interface com.amazon.carbonado.capability.IndexInfoCapability (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><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfoCapability.html" target="_top">Frames</a></li> +<li><a href="IndexInfoCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.IndexInfoCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.IndexInfoCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.IndexInfoCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfoCapability.html" target="_top">Frames</a></li> +<li><a href="IndexInfoCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html new file mode 100644 index 0000000..f245205 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html @@ -0,0 +1,186 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Call (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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Call (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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Call" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedure.Call</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><R,D> <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></code></td> +<td class="colLast"><span class="strong">RemoteProcedureCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)">beginCall</a></strong>(<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc)</code> +<div class="block">Begins a call to execute the given procedure on a remote host.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#send(D)">send</a></strong>(<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data)</code> +<div class="block">Send data to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor)</code> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable)</code> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Call.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html new file mode 100644 index 0000000..10f2da8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html @@ -0,0 +1,186 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Reply (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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Reply (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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Reply.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Reply" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedure.Reply</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Request.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#beginReply()">beginReply</a></strong>()</code> +<div class="block">Begin a reply after receiving all data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the reply, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#send(R)">send</a></strong>(<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a> data)</code> +<div class="block">Send reply data to the caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> cursor)</code> +<div class="block">Reply with all data from the given cursor to the caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> iterable)</code> +<div class="block">Reply with all data from the given iterable to the caller.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Reply.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html new file mode 100644 index 0000000..f26f2b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Request (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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Request (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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Request" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedure.Request</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html#handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)">handleRequest</a></strong>(<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> request)</code> +<div class="block">Request handler for remote procedure implementation.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.Request.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html new file mode 100644 index 0000000..a9831e7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedure (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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure (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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedure" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedure</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><R,D> <a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></code></td> +<td class="colLast"><span class="strong">RemoteProcedureCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)">beginCall</a></strong>(<a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc)</code> +<div class="block">Begins a call to execute the given procedure on a remote host.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedure.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedure.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html new file mode 100644 index 0000000..6da012c --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.RemoteProcedureCapability (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="Uses of Interface com.amazon.carbonado.capability.RemoteProcedureCapability (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><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedureCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.RemoteProcedureCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.RemoteProcedureCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.RemoteProcedureCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html" target="_top">Frames</a></li> +<li><a href="RemoteProcedureCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html new file mode 100644 index 0000000..ab27e14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html @@ -0,0 +1,165 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.capability.ResyncCapability.Listener (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="Uses of Class com.amazon.carbonado.capability.ResyncCapability.Listener (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><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.Listener.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"> +<h2 title="Uses of Class com.amazon.carbonado.capability.ResyncCapability.Listener" class="title">Uses of Class<br>com.amazon.carbonado.capability.ResyncCapability.Listener</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.Listener.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html new file mode 100644 index 0000000..369f856 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.ResyncCapability (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="Uses of Interface com.amazon.carbonado.capability.ResyncCapability (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><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ResyncCapability.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.ResyncCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.ResyncCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.ResyncCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ResyncCapability.html" target="_top">Frames</a></li> +<li><a href="ResyncCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html new file mode 100644 index 0000000..5b8e69b --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.ShutdownCapability (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="Uses of Interface com.amazon.carbonado.capability.ShutdownCapability (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><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.ShutdownCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.ShutdownCapability</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a><Txn></strong></code> +<div class="block">Implements basic functionality required by a core Repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html new file mode 100644 index 0000000..887aad2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.capability.StorableInfoCapability (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="Uses of Interface com.amazon.carbonado.capability.StorableInfoCapability (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><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/StorableInfoCapability.html" target="_top">Frames</a></li> +<li><a href="StorableInfoCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.StorableInfoCapability" class="title">Uses of Interface<br>com.amazon.carbonado.capability.StorableInfoCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.capability.StorableInfoCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/StorableInfoCapability.html" target="_top">Frames</a></li> +<li><a href="StorableInfoCapability.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> diff --git a/apidocs/com/amazon/carbonado/capability/package-frame.html b/apidocs/com/amazon/carbonado/capability/package-frame.html new file mode 100644 index 0000000..4891a36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-frame.html @@ -0,0 +1,36 @@ +<!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.capability (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/capability/package-summary.html" target="classFrame">com.amazon.carbonado.capability</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Capability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>Capability</i></a></li> +<li><a href="GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>GroupAccessCapability</i></a></li> +<li><a href="GroupMembers.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>GroupMembers</i></a></li> +<li><a href="IndexInfo.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>IndexInfo</i></a></li> +<li><a href="IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>IndexInfoCapability</i></a></li> +<li><a href="RemoteProcedure.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedure</i></a></li> +<li><a href="RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedure.Call</i></a></li> +<li><a href="RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedure.Reply</i></a></li> +<li><a href="RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedure.Request</i></a></li> +<li><a href="RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>RemoteProcedureCapability</i></a></li> +<li><a href="ResyncCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>ResyncCapability</i></a></li> +<li><a href="ShutdownCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>ShutdownCapability</i></a></li> +<li><a href="StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability" target="classFrame"><i>StorableInfoCapability</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability" target="classFrame">ResyncCapability.Listener</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/capability/package-summary.html b/apidocs/com/amazon/carbonado/capability/package-summary.html new file mode 100644 index 0000000..af0b7c6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-summary.html @@ -0,0 +1,238 @@ +<!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.capability (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.capability (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><a href="../../../../com/amazon/carbonado/adapter/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/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.capability</h1> +<div class="docSummary"> +<div class="block">Common capabilities for repositories.</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></td> +<td class="colLast"> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">GroupAccessCapability</a></td> +<td class="colLast"> +<div class="block">Capability for gaining access to replication group members.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></td> +<td class="colLast"> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">IndexInfoCapability</a></td> +<td class="colLast"> +<div class="block">Capability for getting information about physical indexes for storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D></td> +<td class="colLast"> +<div class="block">Defines a remote procedure which can be executed by <a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedureCapability</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></td> +<td class="colLast"> +<div class="block">Client-side call into a remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><R></td> +<td class="colLast"> +<div class="block">Reply from remote procedure implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><R,D></td> +<td class="colLast"> +<div class="block">Request into a remote procedure, as seen by procedure implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">RemoteProcedureCapability</a></td> +<td class="colLast"> +<div class="block">Capability which allows arbitrary code to run on a remote host and access + its repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></td> +<td class="colLast"> +<div class="block">Capability of replicating repositories for re-synchronizing to the master + repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></td> +<td class="colLast"> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></td> +<td class="colLast"> +<div class="block">Capability that returns information about known storable types in a + repository.</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/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><S></td> +<td class="colLast"> +<div class="block">Trigger which is invoked as storables get re-sync'd.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.capability Description">Package com.amazon.carbonado.capability Description</h2> +<div class="block">Common capabilities for repositories.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)"><code>Repository.getCapability(java.lang.Class<C>)</code></a></dd></dl> +</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><a href="../../../../com/amazon/carbonado/adapter/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/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> diff --git a/apidocs/com/amazon/carbonado/capability/package-tree.html b/apidocs/com/amazon/carbonado/capability/package-tree.html new file mode 100644 index 0000000..94bd294 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-tree.html @@ -0,0 +1,157 @@ +<!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.capability Class Hierarchy (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.capability Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/adapter/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.capability</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Trigger</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">ResyncCapability.Listener</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">GroupAccessCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfoCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedureCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">ResyncCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">ShutdownCapability</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">StorableInfoCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">GroupMembers</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfo</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Call</span></a><R,D></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Reply</span></a><R></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Request</span></a><R,D></li> +<li type="circle">java.io.Serializable +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure</span></a><R,D></li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/adapter/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/capability/package-use.html b/apidocs/com/amazon/carbonado/capability/package-use.html new file mode 100644 index 0000000..30c510b --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-use.html @@ -0,0 +1,420 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.capability (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="Uses of Package com.amazon.carbonado.capability (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.capability" class="title">Uses of Package<br>com.amazon.carbonado.capability</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.capability">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/GroupMembers.html#com.amazon.carbonado.capability">GroupMembers</a> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.capability">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/RemoteProcedure.html#com.amazon.carbonado.capability">RemoteProcedure</a> +<div class="block">Defines a remote procedure which can be executed by <a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedureCapability</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html#com.amazon.carbonado.capability">RemoteProcedure.Call</a> +<div class="block">Client-side call into a remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html#com.amazon.carbonado.capability">RemoteProcedure.Reply</a> +<div class="block">Reply from remote procedure implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html#com.amazon.carbonado.capability">RemoteProcedure.Request</a> +<div class="block">Request into a remote procedure, as seen by procedure implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html#com.amazon.carbonado.capability">ResyncCapability.Listener</a> +<div class="block">Trigger which is invoked as storables get re-sync'd.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.info">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.layout">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.repo.indexed">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.repo.indexed">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.repo.jdbc">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.repo.jdbc">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.repo.logging">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.repo.sleepycat">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.sequence">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/Capability.html#com.amazon.carbonado.spi">Capability</a> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/IndexInfo.html#com.amazon.carbonado.spi">IndexInfo</a> +<div class="block">General information about an index defined in a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/capability/class-use/ShutdownCapability.html#com.amazon.carbonado.spi">ShutdownCapability</a> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Alias.html b/apidocs/com/amazon/carbonado/class-use/Alias.html new file mode 100644 index 0000000..9427435 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Alias.html @@ -0,0 +1,320 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Alias (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="Uses of Class com.amazon.carbonado.Alias (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><a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Alias.html" target="_top">Frames</a></li> +<li><a href="Alias.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"> +<h2 title="Uses of Class com.amazon.carbonado.Alias" class="title">Uses of Class<br>com.amazon.carbonado.Alias</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with annotations of type <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></strong></code> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></strong></code> +<div class="block">Maps layout generations which are equivalent.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></strong></code> +<div class="block">Stored property joined to a <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with annotations of type <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></strong></code> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with annotations of type <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></strong></code> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> with annotations of type <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></strong></code> +<div class="block">Stores data for <a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><code>SequenceValueGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> with annotations of type <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">StoredSequence.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#getInitialValue()">getInitialValue</a></strong>()</code> +<div class="block">Returns the initial value for the sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">StoredSequence.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">StoredSequence.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#getNextValue()">getNextValue</a></strong>()</code> +<div class="block">Returns the pre-adjusted next value of the sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">StoredSequence.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with annotations of type <a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Alias</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></strong></code> +<div class="block">Can be used internally by repositories for supporting Lobs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Alias.html" target="_top">Frames</a></li> +<li><a href="Alias.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> diff --git a/apidocs/com/amazon/carbonado/class-use/AlternateKeys.html b/apidocs/com/amazon/carbonado/class-use/AlternateKeys.html new file mode 100644 index 0000000..1b54809 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/AlternateKeys.html @@ -0,0 +1,170 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.AlternateKeys (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="Uses of Class com.amazon.carbonado.AlternateKeys (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><a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/AlternateKeys.html" target="_top">Frames</a></li> +<li><a href="AlternateKeys.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"> +<h2 title="Uses of Class com.amazon.carbonado.AlternateKeys" class="title">Uses of Class<br>com.amazon.carbonado.AlternateKeys</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">AlternateKeys</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">AlternateKeys</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with annotations of type <a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">AlternateKeys</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></strong></code> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></strong></code> +<div class="block">Stored property joined to a <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/AlternateKeys.html" target="_top">Frames</a></li> +<li><a href="AlternateKeys.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Authoritative.html b/apidocs/com/amazon/carbonado/class-use/Authoritative.html new file mode 100644 index 0000000..7ddf61a --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Authoritative.html @@ -0,0 +1,190 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Authoritative (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="Uses of Class com.amazon.carbonado.Authoritative (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><a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Authoritative.html" target="_top">Frames</a></li> +<li><a href="Authoritative.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"> +<h2 title="Uses of Class com.amazon.carbonado.Authoritative" class="title">Uses of Class<br>com.amazon.carbonado.Authoritative</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">Authoritative</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">Authoritative</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> with annotations of type <a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">Authoritative</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></strong></code> +<div class="block">Stores data for <a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><code>SequenceValueGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">Authoritative</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with annotations of type <a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">Authoritative</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Authoritative.html" target="_top">Frames</a></li> +<li><a href="Authoritative.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Automatic.html b/apidocs/com/amazon/carbonado/class-use/Automatic.html new file mode 100644 index 0000000..399fe82 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Automatic.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Automatic (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="Uses of Class com.amazon.carbonado.Automatic (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><a href="../../../../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Automatic.html" target="_top">Frames</a></li> +<li><a href="Automatic.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"> +<h2 title="Uses of Class com.amazon.carbonado.Automatic" class="title">Uses of Class<br>com.amazon.carbonado.Automatic</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.Automatic</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Automatic.html" target="_top">Frames</a></li> +<li><a href="Automatic.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> diff --git a/apidocs/com/amazon/carbonado/class-use/ConfigurationException.html b/apidocs/com/amazon/carbonado/class-use/ConfigurationException.html new file mode 100644 index 0000000..c603220 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/ConfigurationException.html @@ -0,0 +1,338 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.ConfigurationException (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="Uses of Class com.amazon.carbonado.ConfigurationException (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><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/ConfigurationException.html" target="_top">Frames</a></li> +<li><a href="ConfigurationException.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"> +<h2 title="Uses of Class com.amazon.carbonado.ConfigurationException" class="title">Uses of Class<br>com.amazon.carbonado.ConfigurationException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that throw <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build()">build</a></strong>()</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootReference)</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that throw <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">IndexedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a> in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that throw <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">JDBCRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>javax.sql.DataSource</code></td> +<td class="colLast"><span class="strong">JDBCRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSource()">getDataSource</a></strong>()</code> +<div class="block">Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a> in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> that throw <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LoggingRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a> in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a> that throw <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ReplicatedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that throw <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that throw <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a></strong>()</code> +<div class="block">Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">AbstractRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/ConfigurationException.html" target="_top">Frames</a></li> +<li><a href="ConfigurationException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/ConstraintException.html b/apidocs/com/amazon/carbonado/class-use/ConstraintException.html new file mode 100644 index 0000000..ca29a7a --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/ConstraintException.html @@ -0,0 +1,163 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.ConstraintException (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="Uses of Class com.amazon.carbonado.ConstraintException (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><a href="../../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/ConstraintException.html" target="_top">Frames</a></li> +<li><a href="ConstraintException.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"> +<h2 title="Uses of Class com.amazon.carbonado.ConstraintException" class="title">Uses of Class<br>com.amazon.carbonado.ConstraintException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></strong></code> +<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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/ConstraintException.html" target="_top">Frames</a></li> +<li><a href="ConstraintException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/CorruptEncodingException.html b/apidocs/com/amazon/carbonado/class-use/CorruptEncodingException.html new file mode 100644 index 0000000..7e5c4e0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/CorruptEncodingException.html @@ -0,0 +1,595 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.CorruptEncodingException (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="Uses of Class com.amazon.carbonado.CorruptEncodingException (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><a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/CorruptEncodingException.html" target="_top">Frames</a></li> +<li><a href="CorruptEncodingException.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"> +<h2 title="Uses of Class com.amazon.carbonado.CorruptEncodingException" class="title">Uses of Class<br>com.amazon.carbonado.CorruptEncodingException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a> in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that throw <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, java.math.BigDecimal[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef)</code> +<div class="block">Decodes the given BigDecimal as originally encoded for ascending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, java.math.BigDecimal[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef)</code> +<div class="block">Decodes a BigDecimal.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, java.math.BigInteger[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef)</code> +<div class="block">Decodes the given BigInteger as originally encoded for ascending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, java.math.BigInteger[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef)</code> +<div class="block">Decodes a BigInteger.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, byte[][])">decode</a></strong>(byte[] src, + int srcOffset, + byte[][] valueRef)</code> +<div class="block">Decodes the given byte array as originally encoded for ascending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, byte[][])">decode</a></strong>(byte[] src, + int srcOffset, + byte[][] valueRef)</code> +<div class="block">Decodes the given byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.Decoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html#decode(S, byte[])">decode</a></strong>(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="type parameter in GenericStorableCodec.Decoder">S</a> dest, + byte[] data)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#decode(S, int, byte[])">decode</a></strong>(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> dest, + int generation, + byte[] data)</code> +<div class="block">Used for decoding different generations of Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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>void</code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#decode(S, int, byte[])">decode</a></strong>(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> dest, + int generation, + byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeBoolean(byte[], int)">decodeBoolean</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a boolean from exactly 1 byte.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeBooleanDesc(byte[], int)">decodeBooleanDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a boolean from exactly 1 byte, as encoded for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Boolean</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeBooleanObj(byte[], int)">decodeBooleanObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Boolean object from exactly 1 byte.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Boolean</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeBooleanObjDesc(byte[], int)">decodeBooleanObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeByte(byte[], int)">decodeByte</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed byte from exactly 1 byte.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeByteDesc(byte[], int)">decodeByteDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed byte from exactly 1 byte, as encoded for descending + order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Byte</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeByteObj(byte[], int)">decodeByteObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Byte</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeByteObjDesc(byte[], int)">decodeByteObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static char</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeChar(byte[], int)">decodeChar</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a char from exactly 2 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Character</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeCharacterObj(byte[], int)">decodeCharacterObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Character</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeCharacterObjDesc(byte[], int)">decodeCharacterObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static char</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeCharDesc(byte[], int)">decodeCharDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a char from exactly 2 bytes, as encoded for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.</span><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="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, java.math.BigDecimal[])">decodeDesc</a></strong>(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef)</code> +<div class="block">Decodes the given BigDecimal as originally encoded for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, java.math.BigInteger[])">decodeDesc</a></strong>(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef)</code> +<div class="block">Decodes the given BigInteger as originally encoded for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, byte[][])">decodeDesc</a></strong>(byte[] src, + int srcOffset, + byte[][] valueRef)</code> +<div class="block">Decodes the given byte array as originally encoded for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static double</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDouble(byte[], int)">decodeDouble</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a double from exactly 8 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static long</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDoubleBits(byte[], int)">decodeDoubleBits</a></strong>(byte[] src, + int srcOffset)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static double</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDoubleDesc(byte[], int)">decodeDoubleDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a double from exactly 8 bytes, as encoded for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Double</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDoubleObj(byte[], int)">decodeDoubleObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Double</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDoubleObjDesc(byte[], int)">decodeDoubleObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloat(byte[], int)">decodeFloat</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a float from exactly 4 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static int</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloatBits(byte[], int)">decodeFloatBits</a></strong>(byte[] src, + int srcOffset)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeFloatDesc(byte[], int)">decodeFloatDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a float from exactly 4 bytes, as encoded for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Float</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloatObj(byte[], int)">decodeFloatObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Float</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeFloatObjDesc(byte[], int)">decodeFloatObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeInt(byte[], int)">decodeInt</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed integer from exactly 4 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeIntDesc(byte[], int)">decodeIntDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Integer</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeIntegerObj(byte[], int)">decodeIntegerObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Integer</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeIntegerObjDesc(byte[], int)">decodeIntegerObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeLong(byte[], int)">decodeLong</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed long from exactly 8 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeLongDesc(byte[], int)">decodeLongDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed long from exactly 8 bytes, as encoded for descending + order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Long</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeLongObj(byte[], int)">decodeLongObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Long</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeLongObjDesc(byte[], int)">decodeLongObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.</span><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>static short</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeShort(byte[], int)">decodeShort</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed short from exactly 2 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static short</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeShortDesc(byte[], int)">decodeShortDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed short from exactly 2 bytes, as encoded for descending + order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Short</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeShortObj(byte[], int)">decodeShortObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Short</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeShortObjDesc(byte[], int)">decodeShortObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingle(byte[], int, int)">decodeSingle</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)"><code>DataEncoder.encodeSingle(byte[], int, int)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleDesc(byte[])">decodeSingleDesc</a></strong>(byte[] src)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])"><code>KeyEncoder.encodeSingleDesc(byte[])</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleDesc(byte[], int, int)">decodeSingleDesc</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])"><code>KeyEncoder.encodeSingleDesc(byte[])</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingleNullable(byte[])">decodeSingleNullable</a></strong>(byte[] src)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingleNullable(byte[], int, int)">decodeSingleNullable</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleNullableDesc(byte[])">decodeSingleNullableDesc</a></strong>(byte[] src)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])"><code>KeyEncoder.encodeSingleNullableDesc(byte[])</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleNullableDesc(byte[], int, int)">decodeSingleNullableDesc</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])"><code>KeyEncoder.encodeSingleNullableDesc(byte[])</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeString(byte[], int, java.lang.String[])">decodeString</a></strong>(byte[] src, + int srcOffset, + java.lang.String[] valueRef)</code> +<div class="block">Decodes an encoded string from the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">DataDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeString(byte[], int, java.lang.String[])">decodeString</a></strong>(byte[] src, + int srcOffset, + java.lang.String[] valueRef)</code> +<div class="block">Decodes an encoded string from the given byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><span class="strong">KeyDecoder.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeStringDesc(byte[], int, java.lang.String[])">decodeStringDesc</a></strong>(byte[] src, + int srcOffset, + java.lang.String[] valueRef)</code> +<div class="block">Decodes an encoded string from the given byte array as originally + encoded for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">GzipCompressor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GzipCompressor.html#decompress(byte[], int)">decompress</a></strong>(byte[] value, + int prefix)</code> +<div class="block">Decodes from compressed form.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/CorruptEncodingException.html" target="_top">Frames</a></li> +<li><a href="CorruptEncodingException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Cursor.html b/apidocs/com/amazon/carbonado/class-use/Cursor.html new file mode 100644 index 0000000..f476438 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Cursor.html @@ -0,0 +1,908 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.Cursor (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="Uses of Interface com.amazon.carbonado.Cursor (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><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Cursor.html" target="_top">Frames</a></li> +<li><a href="Cursor.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"> +<h2 title="Uses of Interface com.amazon.carbonado.Cursor" class="title">Uses of Interface<br>com.amazon.carbonado.Cursor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetch()">fetch</a></strong>()</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T)">fetchAfter</a></strong>(T start)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a> in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#fetchReply()">fetchReply</a></strong>()</code> +<div class="block">Executes the call and receive a reply.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with parameters of type <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor)</code> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> cursor)</code> +<div class="block">Reply with all data from the given cursor to the caller.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a> in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> that implement <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></strong></code> +<div class="block">AbstractCursor implements a small set of common Cursor methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a><S></strong></code> +<div class="block">Wraps another cursor and periodically calls a <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><code>controller</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a><S></strong></code> +<div class="block">Wraps two Cursors and performs an <i>asymmetric set difference</i> + operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a><S></strong></code> +<div class="block">Special cursor implementation that is empty.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a><S></strong></code> +<div class="block">Cursor implementation which fetches records in advance, in order to release locks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a><S></strong></code> +<div class="block">Wraps another cursor and applies custom filtering to reduce the set of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a><S,G></strong></code> +<div class="block">Abstract cursor for aggregation and finding distinct data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a><S></strong></code> +<div class="block">Wraps two Cursors and performs a <i>set intersection</i> operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a><S></strong></code> +<div class="block">Adapts an Iterator into a Cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a><S></strong></code> +<div class="block">Wraps another cursor to limit the amount of elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a><S,T></strong></code> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a set of target storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a><S></strong></code> +<div class="block">Special cursor implementation that returns only one element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a><S></strong></code> +<div class="block">Wraps another cursor to skip an initial amount of elements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a><S></strong></code> +<div class="block">Wraps another Cursor and ensures the results are sorted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a><S></strong></code> +<div class="block">Wraps two Cursors and performs a <i>symmetric set difference</i> + operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a><S></strong></code> +<div class="block">Wraps another cursor and fetches results at a reduced speed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a><S,T></strong></code> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a target storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a><S></strong></code> +<div class="block">Wraps two Cursors and performs a <i>set union</i> operation.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> that return <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">ControllerCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#apply(com.amazon.carbonado.Cursor, com.amazon.carbonado.Query.Controller)">apply</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> source, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a ControllerCursor depending on whether a controller instance is + passed in or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String, java.lang.Object...)">applyFilter</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor, + java.lang.Class<S> type, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Returns a Cursor that is filtered by the given filter expression and values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Cursor)">applyFilter</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S> filterValues, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Returns a Cursor that is filtered by the given Filter and FilterValues.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">EmptyCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#the()">the</a></strong>()</code> +<div class="block">Returns the empty cursor instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a>></code></td> +<td class="colLast"><span class="strong">MultiTransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#transform(S)">transform</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">S</a> storable)</code> +<div class="block">This method must be implemented to transform storables.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">ControllerCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#apply(com.amazon.carbonado.Cursor, com.amazon.carbonado.Query.Controller)">apply</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> source, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a ControllerCursor depending on whether a controller instance is + passed in or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String, java.lang.Object...)">applyFilter</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor, + java.lang.Class<S> type, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Returns a Cursor that is filtered by the given filter expression and values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Cursor)">applyFilter</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S> filterValues, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Returns a Cursor that is filtered by the given Filter and FilterValues.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html#DifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">DifferenceCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> order)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html#DifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">DifferenceCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> order)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html#FetchAheadCursor(com.amazon.carbonado.Cursor, int)">FetchAheadCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="type parameter in FetchAheadCursor">S</a>> source, + int fetchAhead)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#FilteredCursor(com.amazon.carbonado.Cursor)">FilteredCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a>> cursor)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String...)">GroupedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> cursor, + java.lang.Class<<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> type, + java.lang.String... groupProperties)</code> +<div class="block">Create a GroupedCursor using properties to define the group + comparator.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.util.Comparator)">GroupedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> cursor, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> groupComparator)</code> +<div class="block">Create a GroupedCursor with an existing group comparator.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html#IntersectionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">IntersectionCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> order)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html#IntersectionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">IntersectionCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> order)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#LimitCursor(com.amazon.carbonado.Cursor, long)">LimitCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a>> source, + long limit)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#MultiTransformedCursor(com.amazon.carbonado.Cursor)">MultiTransformedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">S</a>> cursor)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#SkipCursor(com.amazon.carbonado.Cursor, long)">SkipCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a>> source, + long skip)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.lang.Class, java.lang.String...)">SortedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> cursor, + <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> buffer, + java.lang.Class<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> type, + java.lang.String... orderProperties)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.util.Comparator, java.util.Comparator)">SortedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> cursor, + <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> buffer, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> handled, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> finisher)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#SymmetricDifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">SymmetricDifferenceCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> order)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#SymmetricDifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">SymmetricDifferenceCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> order)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#ThrottledCursor(com.amazon.carbonado.Cursor, double)">ThrottledCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a>> cursor, + double throttle)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#TransformedCursor(com.amazon.carbonado.Cursor)">TransformedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">S</a>> cursor)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html#UnionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">UnionCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> order)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html#UnionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">UnionCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> order)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetch()">fetch</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetch()">fetch</a></strong>()</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T)">fetchAfter</a></strong>(T start)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll()">fetchAll</a></strong>()</code> +<div class="block">Perform a full scan of all Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll(com.amazon.carbonado.Query.Controller)">fetchAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform a full scan of all Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a> in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that implement <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a><S></strong></code> +<div class="block">Abstract Cursor implementation for a repository that manipulates raw bytes.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a> in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> with parameters of type <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#register(java.lang.Class, com.amazon.carbonado.Cursor)">register</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#unregister(java.lang.Class, com.amazon.carbonado.Cursor)">unregister</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Unregisters a previously registered cursor.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Cursor.html" target="_top">Frames</a></li> +<li><a href="Cursor.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Derived.html b/apidocs/com/amazon/carbonado/class-use/Derived.html new file mode 100644 index 0000000..1938730 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Derived.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Derived (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="Uses of Class com.amazon.carbonado.Derived (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><a href="../../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Derived.html" target="_top">Frames</a></li> +<li><a href="Derived.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"> +<h2 title="Uses of Class com.amazon.carbonado.Derived" class="title">Uses of Class<br>com.amazon.carbonado.Derived</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.Derived</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Derived.html" target="_top">Frames</a></li> +<li><a href="Derived.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> diff --git a/apidocs/com/amazon/carbonado/class-use/FetchDeadlockException.html b/apidocs/com/amazon/carbonado/class-use/FetchDeadlockException.html new file mode 100644 index 0000000..95bc832 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/FetchDeadlockException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.FetchDeadlockException (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="Uses of Class com.amazon.carbonado.FetchDeadlockException (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><a href="../../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchDeadlockException.html" target="_top">Frames</a></li> +<li><a href="FetchDeadlockException.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"> +<h2 title="Uses of Class com.amazon.carbonado.FetchDeadlockException" class="title">Uses of Class<br>com.amazon.carbonado.FetchDeadlockException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.FetchDeadlockException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchDeadlockException.html" target="_top">Frames</a></li> +<li><a href="FetchDeadlockException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/FetchException.html b/apidocs/com/amazon/carbonado/class-use/FetchException.html new file mode 100644 index 0000000..6c52f67 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/FetchException.html @@ -0,0 +1,2152 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.FetchException (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="Uses of Class com.amazon.carbonado.FetchException (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><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchException.html" target="_top">Frames</a></li> +<li><a href="FetchException.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"> +<h2 title="Uses of Class com.amazon.carbonado.FetchException" class="title">Uses of Class<br>com.amazon.carbonado.FetchException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></strong></code> +<div class="block">A CorruptEncodingException is caused when decoding an encoded record fails.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a></strong></code> +<div class="block">Thrown from a fetch operation that was canceled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></strong></code> +<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="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></strong></code> +<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="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></strong></code> +<div class="block">Thrown if a fetch operation fails because lock acquisition timed out.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">PersistDeadlockException.</span><code><strong><a href="../../../../com/amazon/carbonado/PersistDeadlockException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">PersistNoneException.</span><code><strong><a href="../../../../com/amazon/carbonado/PersistNoneException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">PersistInterruptedException.</span><code><strong><a href="../../../../com/amazon/carbonado/PersistInterruptedException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">PersistMultipleException.</span><code><strong><a href="../../../../com/amazon/carbonado/PersistMultipleException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">PersistTimeoutException.</span><code><strong><a href="../../../../com/amazon/carbonado/PersistTimeoutException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">RepositoryException.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">RepositoryException.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException</a></strong>()</code> +<div class="block">Converts RepositoryException into an appropriate FetchException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">RepositoryException.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException</a></strong>(java.lang.String message)</code> +<div class="block">Converts RepositoryException into an appropriate FetchException, prepending + the specified message.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#after(T)">after</a></strong>(T start)</code> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#afterLoad(S)">afterLoad</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called right after a storable has been successfully loaded or + fetched.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#and(java.lang.String)">and</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Cursor.</span><code><strong><a href="../../../../com/amazon/carbonado/Cursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Query.Controller.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.Controller.html#continueCheck()">continueCheck</a></strong>()</code> +<div class="block">Periodically called by query to determine if it should continue.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">Cursor.</span><code><strong><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> c)</code> +<div class="block">Copies all remaining next elements into the given collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">Cursor.</span><code><strong><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection, int)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> c, + int limit)</code> +<div class="block">Copies a limited amount of remaining next elements into the given + collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#count()">count</a></strong>()</code> +<div class="block">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#exists()">exists</a></strong>()</code> +<div class="block">Returns true if any results are matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns true if any results are matched by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetch()">fetch</a></strong>()</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T)">fetchAfter</a></strong>(T start)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Cursor.</span><code><strong><a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#load()">load</a></strong>()</code> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#loadOne()">loadOne</a></strong>()</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a></code></td> +<td class="colLast"><span class="strong">Cursor.</span><code><strong><a href="../../../../com/amazon/carbonado/Cursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#not()">not</a></strong>()</code> +<div class="block">Returns a new query which produces all the results not supplied in this + query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#or(java.lang.String)">or</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> +<div class="block">Returns a copy of this query ordered by specific property values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> +<div class="block">Returns a copy of this query ordered by a specific property value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#query()">query</a></strong>()</code> +<div class="block">Query for all Storable instances in this Storage.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#query(com.amazon.carbonado.filter.Filter)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> filter)</code> +<div class="block">Query for Storable instances against an explicitly constructed filter + object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)">query</a></strong>(java.lang.String filter)</code> +<div class="block">Query for Storable instances against a filter expression.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">Cursor.</span><code><strong><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>></code></td> +<td class="colLast"><span class="strong">Cursor.</span><code><strong><a href="../../../../com/amazon/carbonado/Cursor.html#toList()">toList</a></strong>()</code> +<div class="block">Copies all remaining next elements into a new modifiable list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>></code></td> +<td class="colLast"><span class="strong">Cursor.</span><code><strong><a href="../../../../com/amazon/carbonado/Cursor.html#toList(int)">toList</a></strong>(int limit)</code> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad</a></strong>()</code> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne()">tryLoadOne</a></strong>()</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Blob)">adaptToString</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Clob)">adaptToString</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><span class="strong">GroupedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#addToGroup(S)">addToGroup</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a> groupMember)</code> +<div class="block">This method is called when more entries are found for the current + group.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><span class="strong">GroupedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#beginGroup(S)">beginGroup</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a> groupLeader)</code> +<div class="block">This method is called for the first entry in a group.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">MultiTransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LimitCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ThrottledCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">IntersectionCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">DifferenceCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ControllerCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">FetchAheadCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SkipCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">UnionCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SortBuffer.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#close()">close</a></strong>()</code> +<div class="block">Clear and close buffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GroupedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SymmetricDifferenceCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">SymmetricDifferenceCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#compareNext()">compareNext</a></strong>()</code> +<div class="block">Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">AbstractCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> c)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">AbstractCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> c, + int limit)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a></code></td> +<td class="colLast"><span class="strong">GroupedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#finishGroup()">finishGroup</a></strong>()</code> +<div class="block">This method is called when a group is finished, and it can return an + aggregate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">MultiTransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">LimitCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">ThrottledCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IntersectionCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DifferenceCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">ControllerCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">FetchAheadCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SkipCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">UnionCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">GroupedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">TransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SymmetricDifferenceCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#isAllowed(S)">isAllowed</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a></code></td> +<td class="colLast"><span class="strong">MultiTransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a></code></td> +<td class="colLast"><span class="strong">LimitCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a></code></td> +<td class="colLast"><span class="strong">ThrottledCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a></code></td> +<td class="colLast"><span class="strong">IntersectionCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a></code></td> +<td class="colLast"><span class="strong">DifferenceCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="type parameter in ControllerCursor">S</a></code></td> +<td class="colLast"><span class="strong">ControllerCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="type parameter in FetchAheadCursor">S</a></code></td> +<td class="colLast"><span class="strong">FetchAheadCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a></code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a></code></td> +<td class="colLast"><span class="strong">SkipCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a></code></td> +<td class="colLast"><span class="strong">UnionCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a></code></td> +<td class="colLast"><span class="strong">GroupedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a></code></td> +<td class="colLast"><span class="strong">TransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a></code></td> +<td class="colLast"><span class="strong">SymmetricDifferenceCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">MultiTransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">LimitCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">ThrottledCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">AbstractCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">SkipCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">GroupedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">TransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SortBuffer.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#sort()">sort</a></strong>()</code> +<div class="block">Finish sorting buffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></strong>(int limit)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a>></code></td> +<td class="colLast"><span class="strong">MultiTransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#transform(S)">transform</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">S</a> storable)</code> +<div class="block">This method must be implemented to transform storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a></code></td> +<td class="colLast"><span class="strong">TransformedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#transform(S)">transform</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">S</a> storable)</code> +<div class="block">This method must be implemented to transform storables.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DelegateSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html#doTryLoad(S)">doTryLoad</a></strong>(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#equalLayouts(com.amazon.carbonado.layout.Layout)">equalLayouts</a></strong>(<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> +<div class="block">Returns true if the given layout matches this one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Returns all the properties of this layout, in their proper order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getDataProperties()">getDataProperties</a></strong>()</code> +<div class="block">Returns all the non-primary key properties of this layout, in their + proper order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getGeneration(int)">getGeneration</a></strong>(int generation)</code> +<div class="block">Returns the layout for a particular generation of this layout's type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#nextGeneration()">nextGeneration</a></strong>()</code> +<div class="block">Returns the next known generation of the storable's layout, or null + if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#previousGeneration()">previousGeneration</a></strong>()</code> +<div class="block">Returns the previous known generation of the storable's layout, or null + if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#reconstruct()">reconstruct</a></strong>()</code> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#reconstruct(java.lang.ClassLoader)">reconstruct</a></strong>(java.lang.ClassLoader loader)</code> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Clob data as a single String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">AbstractBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString()">asString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">AbstractClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">AbstractBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.nio.charset.Charset)">asString</a></strong>(java.nio.charset.Charset charset)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.nio.charset.Charset)">asString</a></strong>(java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">AbstractBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.lang.String)">asString</a></strong>(java.lang.String charsetName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.lang.String)">asString</a></strong>(java.lang.String charsetName)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">StringClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#getLength()">getLength</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#getLength()">getLength</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FileBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#getLength()">getLength</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream()">openInputStream</a></strong>()</code> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><span class="strong">FileBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream()">openInputStream</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">openInputStream</a></strong>(long pos)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><span class="strong">FileBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream(long)">openInputStream</a></strong>(long pos)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">openInputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><span class="strong">FileBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream(long, int)">openInputStream</a></strong>(long pos, + int bufferSize)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">openReader</a></strong>()</code> +<div class="block">Returns a Reader for reading Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openReader()">openReader</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><span class="strong">StringClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openReader(long)">openReader</a></strong>(long pos)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openReader(long)">openReader</a></strong>(long pos)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">openReader</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><span class="strong">StringClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openReader(long, int)">openReader</a></strong>(long pos, + int bufferSize)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openReader(long, int)">openReader</a></strong>(long pos, + int bufferSize)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#after(T)">after</a></strong>(T start)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#and(java.lang.String)">and</a></strong>(java.lang.String filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#count()">count</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll()">countAll</a></strong>()</code> +<div class="block">Counts all Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll(com.amazon.carbonado.Query.Controller)">countAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts all Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutorFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#exists()">exists</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetch()">fetch</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T)">fetchAfter</a></strong>(T start)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll()">fetchAll</a></strong>()</code> +<div class="block">Perform a full scan of all Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll(com.amazon.carbonado.Query.Controller)">fetchAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform a full scan of all Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index)</code> +<div class="block">Returns an open query if the given index supports query access.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne()">loadOne</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#not()">not</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#not()">not</a></strong>()</code> +<div class="block">Returns a query that fetches everything, possibly in a specified order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#or(java.lang.String)">or</a></strong>(java.lang.String filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query()">query</a></strong>()</code> +<div class="block">Returns a new or cached query that fetches everything.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter)</code> +<div class="block">Returns a new or cached query for the given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(java.lang.String)">query</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new or cached query for the given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne()">tryLoadOne</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">DelegatedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)">DelegatedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> executor)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#enableKeyAndValue()">enableKeyAndValue</a></strong>()</code> +<div class="block">Enable key and value acquisition again, after they have been + disabled.</div> +</td> +</tr> +<tr class="altColor"> +<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"><span class="strong">RawSupport.</span><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="rowColor"> +<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"><span class="strong">RawSupport.</span><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="altColor"> +<td class="colFirst"><code>protected abstract byte[]</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#getCurrentKey()">getCurrentKey</a></strong>()</code> +<div class="block">Returns the contents of the current key being referenced, or null + otherwise.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract byte[]</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#getCurrentValue()">getCurrentValue</a></strong>()</code> +<div class="block">Returns the contents of the current value being referenced, or null + otherwise.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getDecoder(int)">getDecoder</a></strong>(int generation)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use direct decode method</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#handleNoSuchElement()">handleNoSuchElement</a></strong>()</code> +<div class="block">Called right before throwing NoSuchElementException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#hasNext()">hasNext</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[])">instantiate</a></strong>(byte[] key)</code> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(byte[])">instantiate</a></strong>(byte[] key)</code> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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="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"><span class="strong">CustomStorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(byte[], byte[])">instantiate</a></strong>(byte[] key, + byte[] value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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/StorableCodec.html" title="type parameter in StorableCodec">S</a>> support, + 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"><span class="strong">CustomStorableCodec.</span><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> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> support, + 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/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">GenericInstanceFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[])">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">GenericInstanceFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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> support, + byte[] key, + byte[] value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.InstanceFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[], com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key, + byte[] value, + <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a></code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#instantiateCurrent()">instantiateCurrent</a></strong>()</code> +<div class="block">Returns a new Storable instance for the currently referenced entry.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a></code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#next()">next</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#release()">release</a></strong>()</code> +<div class="block">Release any internal resources, called when closed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toFirst()">toFirst</a></strong>()</code> +<div class="block">Move the cursor to the first available entry.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toFirst(byte[])">toFirst</a></strong>(byte[] key)</code> +<div class="block">Move the cursor to the first available entry at or after the given + key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toLast()">toLast</a></strong>()</code> +<div class="block">Move the cursor to the last available entry.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toLast(byte[])">toLast</a></strong>(byte[] key)</code> +<div class="block">Move the cursor to the last available entry at or before the given + key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNext()">toNext</a></strong>()</code> +<div class="block">Move the cursor to the next available entry, returning false if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNext(int)">toNext</a></strong>(int amount)</code> +<div class="block">Move the cursor to the next available entry, incrementing by the amount + given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNextKey()">toNextKey</a></strong>()</code> +<div class="block">Move the cursor to the next unique key, returning false if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPrevious()">toPrevious</a></strong>()</code> +<div class="block">Move the cursor to the previous available entry, returning false if + none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPrevious(int)">toPrevious</a></strong>(int amount)</code> +<div class="block">Move the cursor to the previous available entry, decrementing by the + amount given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">RawCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPreviousKey()">toPreviousKey</a></strong>()</code> +<div class="block">Move the cursor to the previous unique key, returning false if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Sets all the properties of the given index entry, using the applicable + properties of the given master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">JDBCConnectionCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toFetchException(java.lang.Throwable)">toFetchException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertBlob(java.sql.Blob, com.amazon.carbonado.repo.jdbc.JDBCBlobLoader)">convertBlob</a></strong>(java.sql.Blob blob, + <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a> loader)</code> </td> +</tr> +<tr class="rowColor"> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertClob(java.sql.Clob, com.amazon.carbonado.repo.jdbc.JDBCClobLoader)">convertClob</a></strong>(java.sql.Clob clob, + <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a> loader)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Connection</code></td> +<td class="colLast"><span class="strong">JDBCConnectionCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getConnection()">getConnection</a></strong>()</code> +<div class="block">Any connection returned by this method must be closed by calling + yieldConnection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Blob</code></td> +<td class="colLast"><span class="strong">JDBCBlobLoader.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html#load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)">load</a></strong>(<a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> cap)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Clob</code></td> +<td class="colLast"><span class="strong">JDBCClobLoader.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html#load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)">load</a></strong>(<a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> cap)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">JDBCConnectionCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#yieldConnection(java.sql.Connection)">yieldConnection</a></strong>(java.sql.Connection con)</code> +<div class="block">Gives up a connection returned from getConnection.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SequenceValueGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#reset(int)">reset</a></strong>(int initialValue)</code> +<div class="block">Reset the sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#returnReservedValues()">returnReservedValues</a></strong>()</code> +<div class="block">Allow any unused reserved values to be returned for re-use.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SequenceValueGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#returnReservedValues()">returnReservedValues</a></strong>()</code> +<div class="block">Allow any unused reserved values to be returned for re-use.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">ExceptionTransformer.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toFetchException(java.lang.Throwable)">toFetchException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><span class="strong">ExceptionTransformer.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoFetchException(java.lang.Throwable)">transformIntoFetchException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterLoad(S)">afterLoad</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that throw <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Sets all the properties of the given reference, using the applicable + properties of the given master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given reference.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Returns true if the properties of the given reference match those + contained in the master, excluding any version property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchException.html" target="_top">Frames</a></li> +<li><a href="FetchException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/FetchInterruptedException.html b/apidocs/com/amazon/carbonado/class-use/FetchInterruptedException.html new file mode 100644 index 0000000..6821e36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/FetchInterruptedException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.FetchInterruptedException (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="Uses of Class com.amazon.carbonado.FetchInterruptedException (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><a href="../../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchInterruptedException.html" target="_top">Frames</a></li> +<li><a href="FetchInterruptedException.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"> +<h2 title="Uses of Class com.amazon.carbonado.FetchInterruptedException" class="title">Uses of Class<br>com.amazon.carbonado.FetchInterruptedException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.FetchInterruptedException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchInterruptedException.html" target="_top">Frames</a></li> +<li><a href="FetchInterruptedException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/FetchMultipleException.html b/apidocs/com/amazon/carbonado/class-use/FetchMultipleException.html new file mode 100644 index 0000000..360eed8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/FetchMultipleException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.FetchMultipleException (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="Uses of Class com.amazon.carbonado.FetchMultipleException (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><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchMultipleException.html" target="_top">Frames</a></li> +<li><a href="FetchMultipleException.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"> +<h2 title="Uses of Class com.amazon.carbonado.FetchMultipleException" class="title">Uses of Class<br>com.amazon.carbonado.FetchMultipleException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.FetchMultipleException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchMultipleException.html" target="_top">Frames</a></li> +<li><a href="FetchMultipleException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/FetchNoneException.html b/apidocs/com/amazon/carbonado/class-use/FetchNoneException.html new file mode 100644 index 0000000..4d04dae --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/FetchNoneException.html @@ -0,0 +1,232 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.FetchNoneException (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="Uses of Class com.amazon.carbonado.FetchNoneException (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><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchNoneException.html" target="_top">Frames</a></li> +<li><a href="FetchNoneException.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"> +<h2 title="Uses of Class com.amazon.carbonado.FetchNoneException" class="title">Uses of Class<br>com.amazon.carbonado.FetchNoneException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that throw <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#load()">load</a></strong>()</code> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that throw <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getGeneration(int)">getGeneration</a></strong>(int generation)</code> +<div class="block">Returns the layout for a particular generation of this layout's type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a> in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that throw <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getDecoder(int)">getDecoder</a></strong>(int generation)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use direct decode method</i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchNoneException.html" target="_top">Frames</a></li> +<li><a href="FetchNoneException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/FetchTimeoutException.html b/apidocs/com/amazon/carbonado/class-use/FetchTimeoutException.html new file mode 100644 index 0000000..95afbff --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/FetchTimeoutException.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.FetchTimeoutException (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="Uses of Class com.amazon.carbonado.FetchTimeoutException (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><a href="../../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchTimeoutException.html" target="_top">Frames</a></li> +<li><a href="FetchTimeoutException.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"> +<h2 title="Uses of Class com.amazon.carbonado.FetchTimeoutException" class="title">Uses of Class<br>com.amazon.carbonado.FetchTimeoutException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that throw <a href="../../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Query.Timeout.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.Timeout.html#continueCheck()">continueCheck</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/FetchTimeoutException.html" target="_top">Frames</a></li> +<li><a href="FetchTimeoutException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Independent.html b/apidocs/com/amazon/carbonado/class-use/Independent.html new file mode 100644 index 0000000..768af50 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Independent.html @@ -0,0 +1,291 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Independent (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="Uses of Class com.amazon.carbonado.Independent (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><a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Independent.html" target="_top">Frames</a></li> +<li><a href="Independent.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"> +<h2 title="Uses of Class com.amazon.carbonado.Independent" class="title">Uses of Class<br>com.amazon.carbonado.Independent</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with annotations of type <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></strong></code> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></strong></code> +<div class="block">Maps layout generations which are equivalent.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></strong></code> +<div class="block">Stored property joined to a <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with annotations of type <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></strong></code> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with annotations of type <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></strong></code> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> with annotations of type <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></strong></code> +<div class="block">Stores data for <a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><code>SequenceValueGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with annotations of type <a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Independent</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></strong></code> +<div class="block">Can be used internally by repositories for supporting Lobs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Independent.html" target="_top">Frames</a></li> +<li><a href="Independent.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Index.html b/apidocs/com/amazon/carbonado/class-use/Index.html new file mode 100644 index 0000000..a0d6b64 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Index.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Index (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="Uses of Class com.amazon.carbonado.Index (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><a href="../../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Index.html" target="_top">Frames</a></li> +<li><a href="Index.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"> +<h2 title="Uses of Class com.amazon.carbonado.Index" class="title">Uses of Class<br>com.amazon.carbonado.Index</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.Index</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Index.html" target="_top">Frames</a></li> +<li><a href="Index.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Indexes.html b/apidocs/com/amazon/carbonado/class-use/Indexes.html new file mode 100644 index 0000000..d9ce9c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Indexes.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Indexes (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="Uses of Class com.amazon.carbonado.Indexes (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><a href="../../../../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Indexes.html" target="_top">Frames</a></li> +<li><a href="Indexes.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"> +<h2 title="Uses of Class com.amazon.carbonado.Indexes" class="title">Uses of Class<br>com.amazon.carbonado.Indexes</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.Indexes</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Indexes.html" target="_top">Frames</a></li> +<li><a href="Indexes.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> diff --git a/apidocs/com/amazon/carbonado/class-use/IsolationLevel.html b/apidocs/com/amazon/carbonado/class-use/IsolationLevel.html new file mode 100644 index 0000000..c954c36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/IsolationLevel.html @@ -0,0 +1,398 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.IsolationLevel (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="Uses of Class com.amazon.carbonado.IsolationLevel (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><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/IsolationLevel.html" target="_top">Frames</a></li> +<li><a href="IsolationLevel.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"> +<h2 title="Uses of Class com.amazon.carbonado.IsolationLevel" class="title">Uses of Class<br>com.amazon.carbonado.IsolationLevel</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">Transaction.</span><code><strong><a href="../../../../com/amazon/carbonado/Transaction.html#getIsolationLevel()">getIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of this transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">IsolationLevel.</span><code><strong><a href="../../../../com/amazon/carbonado/IsolationLevel.html#highestCommon(com.amazon.carbonado.IsolationLevel)">highestCommon</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns the highest common isolation level between this and the one + given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">IsolationLevel.</span><code><strong><a href="../../../../com/amazon/carbonado/IsolationLevel.html#lowestCommon(com.amazon.carbonado.IsolationLevel)">lowestCommon</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns the lowest common isolation level between this and the one + given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">IsolationLevel.</span><code><strong><a href="../../../../com/amazon/carbonado/IsolationLevel.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a>[]</code></td> +<td class="colLast"><span class="strong">IsolationLevel.</span><code><strong><a href="../../../../com/amazon/carbonado/IsolationLevel.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with parameters of type <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">IsolationLevel.</span><code><strong><a href="../../../../com/amazon/carbonado/IsolationLevel.html#highestCommon(com.amazon.carbonado.IsolationLevel)">highestCommon</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns the highest common isolation level between this and the one + given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IsolationLevel.</span><code><strong><a href="../../../../com/amazon/carbonado/IsolationLevel.html#isAtLeast(com.amazon.carbonado.IsolationLevel)">isAtLeast</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns true if this isolation level is at least as high as the one + given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IsolationLevel.</span><code><strong><a href="../../../../com/amazon/carbonado/IsolationLevel.html#isAtMost(com.amazon.carbonado.IsolationLevel)">isAtMost</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns true if this isolation level is no higher than the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">IsolationLevel.</span><code><strong><a href="../../../../com/amazon/carbonado/IsolationLevel.html#lowestCommon(com.amazon.carbonado.IsolationLevel)">lowestCommon</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns the lowest common isolation level between this and the one + given.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> that return <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">TransactionPair.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#getIsolationLevel()">getIsolationLevel</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#getIsolationLevel()">getIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of the active transaction, or null if there + is no active transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#selectIsolationLevel(com.amazon.carbonado.Transaction, com.amazon.carbonado.IsolationLevel)">selectIsolationLevel</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns supported isolation level, which may be higher.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> with parameters of type <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a></code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#createTxn(Txn, com.amazon.carbonado.IsolationLevel)">createTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a></code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#createTxn(Txn, com.amazon.carbonado.IsolationLevel, int, java.util.concurrent.TimeUnit)">createTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level, + int timeout, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#enter(com.amazon.carbonado.IsolationLevel)">enter</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enters a new transaction scope which becomes the active transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#enterTop(com.amazon.carbonado.IsolationLevel)">enterTop</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enters a new top-level transaction scope which becomes the active + transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#selectIsolationLevel(com.amazon.carbonado.Transaction, com.amazon.carbonado.IsolationLevel)">selectIsolationLevel</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns supported isolation level, which may be higher.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/IsolationLevel.html" target="_top">Frames</a></li> +<li><a href="IsolationLevel.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Join.html b/apidocs/com/amazon/carbonado/class-use/Join.html new file mode 100644 index 0000000..faa545e --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Join.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Join (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="Uses of Class com.amazon.carbonado.Join (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><a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Join.html" target="_top">Frames</a></li> +<li><a href="Join.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"> +<h2 title="Uses of Class com.amazon.carbonado.Join" class="title">Uses of Class<br>com.amazon.carbonado.Join</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.Join</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Join.html" target="_top">Frames</a></li> +<li><a href="Join.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Key.html b/apidocs/com/amazon/carbonado/class-use/Key.html new file mode 100644 index 0000000..cd91531 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Key.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Key (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="Uses of Class com.amazon.carbonado.Key (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><a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Key.html" target="_top">Frames</a></li> +<li><a href="Key.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"> +<h2 title="Uses of Class com.amazon.carbonado.Key" class="title">Uses of Class<br>com.amazon.carbonado.Key</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.Key</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Key.html" target="_top">Frames</a></li> +<li><a href="Key.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> diff --git a/apidocs/com/amazon/carbonado/class-use/MalformedArgumentException.html b/apidocs/com/amazon/carbonado/class-use/MalformedArgumentException.html new file mode 100644 index 0000000..9f689a8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/MalformedArgumentException.html @@ -0,0 +1,169 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.MalformedArgumentException (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="Uses of Class com.amazon.carbonado.MalformedArgumentException (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><a href="../../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/MalformedArgumentException.html" target="_top">Frames</a></li> +<li><a href="MalformedArgumentException.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"> +<h2 title="Uses of Class com.amazon.carbonado.MalformedArgumentException" class="title">Uses of Class<br>com.amazon.carbonado.MalformedArgumentException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></strong></code> +<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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/MalformedArgumentException.html" target="_top">Frames</a></li> +<li><a href="MalformedArgumentException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/MalformedFilterException.html b/apidocs/com/amazon/carbonado/class-use/MalformedFilterException.html new file mode 100644 index 0000000..decc8db --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/MalformedFilterException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.MalformedFilterException (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="Uses of Class com.amazon.carbonado.MalformedFilterException (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><a href="../../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/MalformedFilterException.html" target="_top">Frames</a></li> +<li><a href="MalformedFilterException.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"> +<h2 title="Uses of Class com.amazon.carbonado.MalformedFilterException" class="title">Uses of Class<br>com.amazon.carbonado.MalformedFilterException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.MalformedFilterException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/MalformedFilterException.html" target="_top">Frames</a></li> +<li><a href="MalformedFilterException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/MalformedTypeException.html b/apidocs/com/amazon/carbonado/class-use/MalformedTypeException.html new file mode 100644 index 0000000..7ca8fe9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/MalformedTypeException.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.MalformedTypeException (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="Uses of Class com.amazon.carbonado.MalformedTypeException (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><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/MalformedTypeException.html" target="_top">Frames</a></li> +<li><a href="MalformedTypeException.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"> +<h2 title="Uses of Class com.amazon.carbonado.MalformedTypeException" class="title">Uses of Class<br>com.amazon.carbonado.MalformedTypeException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that throw <a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/MalformedTypeException.html" target="_top">Frames</a></li> +<li><a href="MalformedTypeException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/MismatchException.html b/apidocs/com/amazon/carbonado/class-use/MismatchException.html new file mode 100644 index 0000000..ef4c95a --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/MismatchException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.MismatchException (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="Uses of Class com.amazon.carbonado.MismatchException (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><a href="../../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/MismatchException.html" target="_top">Frames</a></li> +<li><a href="MismatchException.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"> +<h2 title="Uses of Class com.amazon.carbonado.MismatchException" class="title">Uses of Class<br>com.amazon.carbonado.MismatchException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.MismatchException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/MismatchException.html" target="_top">Frames</a></li> +<li><a href="MismatchException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Name.html b/apidocs/com/amazon/carbonado/class-use/Name.html new file mode 100644 index 0000000..bb7af85 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Name.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Name (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="Uses of Class com.amazon.carbonado.Name (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><a href="../../../../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Name.html" target="_top">Frames</a></li> +<li><a href="Name.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"> +<h2 title="Uses of Class com.amazon.carbonado.Name" class="title">Uses of Class<br>com.amazon.carbonado.Name</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.Name</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Name.html" target="_top">Frames</a></li> +<li><a href="Name.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> diff --git a/apidocs/com/amazon/carbonado/class-use/NonDurableCommitException.html b/apidocs/com/amazon/carbonado/class-use/NonDurableCommitException.html new file mode 100644 index 0000000..0f19406 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/NonDurableCommitException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.NonDurableCommitException (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="Uses of Class com.amazon.carbonado.NonDurableCommitException (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><a href="../../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/NonDurableCommitException.html" target="_top">Frames</a></li> +<li><a href="NonDurableCommitException.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"> +<h2 title="Uses of Class com.amazon.carbonado.NonDurableCommitException" class="title">Uses of Class<br>com.amazon.carbonado.NonDurableCommitException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.NonDurableCommitException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/NonDurableCommitException.html" target="_top">Frames</a></li> +<li><a href="NonDurableCommitException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Nullable.html b/apidocs/com/amazon/carbonado/class-use/Nullable.html new file mode 100644 index 0000000..9c5b888 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Nullable.html @@ -0,0 +1,272 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Nullable (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="Uses of Class com.amazon.carbonado.Nullable (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><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Nullable.html" target="_top">Frames</a></li> +<li><a href="Nullable.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"> +<h2 title="Uses of Class com.amazon.carbonado.Nullable" class="title">Uses of Class<br>com.amazon.carbonado.Nullable</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Nullable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Nullable</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with annotations of type <a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Nullable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">StoredLayoutProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getAdapterParams()">getAdapterParams</a></strong>()</code> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">StoredLayoutProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getAdapterTypeName()">getAdapterTypeName</a></strong>()</code> +<div class="block">Adapter type name is a fully qualified Java class name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">StoredLayout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getCreationHost()">getCreationHost</a></strong>()</code> +<div class="block">Returns the host machine that created this generation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">StoredLayout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getCreationUser()">getCreationUser</a></strong>()</code> +<div class="block">Returns the user that created this generation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><span class="strong">StoredLayoutProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.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="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><span class="strong">StoredLayout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.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>byte[]</code></td> +<td class="colLast"><span class="strong">StoredLayoutEquivalence.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getExtraData()">getExtraData</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Nullable</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with annotations of type <a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Nullable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><span class="strong">StoredIndexInfo.</span><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="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">StoredIndexInfo.</span><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Nullable</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with annotations of type <a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Nullable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>abstract byte[]</code></td> +<td class="colLast"><span class="strong">StoredDatabaseInfo.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.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="rowColor"> +<td class="colFirst"><code>abstract java.lang.String</code></td> +<td class="colLast"><span class="strong">StoredDatabaseInfo.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getIndexNameDescriptor()">getIndexNameDescriptor</a></strong>()</code> +<div class="block">Returns the index name descriptor for the keys of this database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract java.lang.String</code></td> +<td class="colLast"><span class="strong">StoredDatabaseInfo.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getIndexTypeDescriptor()">getIndexTypeDescriptor</a></strong>()</code> +<div class="block">Returns the types of the index properties.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Nullable.html" target="_top">Frames</a></li> +<li><a href="Nullable.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> diff --git a/apidocs/com/amazon/carbonado/class-use/OptimisticLockException.html b/apidocs/com/amazon/carbonado/class-use/OptimisticLockException.html new file mode 100644 index 0000000..44eb040 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/OptimisticLockException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.OptimisticLockException (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="Uses of Class com.amazon.carbonado.OptimisticLockException (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><a href="../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/OptimisticLockException.html" target="_top">Frames</a></li> +<li><a href="OptimisticLockException.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"> +<h2 title="Uses of Class com.amazon.carbonado.OptimisticLockException" class="title">Uses of Class<br>com.amazon.carbonado.OptimisticLockException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.OptimisticLockException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/OptimisticLockException.html" target="_top">Frames</a></li> +<li><a href="OptimisticLockException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PartitionKey.html b/apidocs/com/amazon/carbonado/class-use/PartitionKey.html new file mode 100644 index 0000000..e82c49d --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PartitionKey.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PartitionKey (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="Uses of Class com.amazon.carbonado.PartitionKey (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><a href="../../../../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PartitionKey.html" target="_top">Frames</a></li> +<li><a href="PartitionKey.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"> +<h2 title="Uses of Class com.amazon.carbonado.PartitionKey" class="title">Uses of Class<br>com.amazon.carbonado.PartitionKey</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.PartitionKey</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PartitionKey.html" target="_top">Frames</a></li> +<li><a href="PartitionKey.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PersistDeadlockException.html b/apidocs/com/amazon/carbonado/class-use/PersistDeadlockException.html new file mode 100644 index 0000000..ac96c5f --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PersistDeadlockException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PersistDeadlockException (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="Uses of Class com.amazon.carbonado.PersistDeadlockException (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><a href="../../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistDeadlockException.html" target="_top">Frames</a></li> +<li><a href="PersistDeadlockException.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"> +<h2 title="Uses of Class com.amazon.carbonado.PersistDeadlockException" class="title">Uses of Class<br>com.amazon.carbonado.PersistDeadlockException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.PersistDeadlockException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistDeadlockException.html" target="_top">Frames</a></li> +<li><a href="PersistDeadlockException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PersistDeniedException.html b/apidocs/com/amazon/carbonado/class-use/PersistDeniedException.html new file mode 100644 index 0000000..b95e512 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PersistDeniedException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PersistDeniedException (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="Uses of Class com.amazon.carbonado.PersistDeniedException (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><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistDeniedException.html" target="_top">Frames</a></li> +<li><a href="PersistDeniedException.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"> +<h2 title="Uses of Class com.amazon.carbonado.PersistDeniedException" class="title">Uses of Class<br>com.amazon.carbonado.PersistDeniedException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.PersistDeniedException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistDeniedException.html" target="_top">Frames</a></li> +<li><a href="PersistDeniedException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PersistException.html b/apidocs/com/amazon/carbonado/class-use/PersistException.html new file mode 100644 index 0000000..0784019 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PersistException.html @@ -0,0 +1,1392 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PersistException (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="Uses of Class com.amazon.carbonado.PersistException (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><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistException.html" target="_top">Frames</a></li> +<li><a href="PersistException.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"> +<h2 title="Uses of Class com.amazon.carbonado.PersistException" class="title">Uses of Class<br>com.amazon.carbonado.PersistException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></strong></code> +<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="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">NonDurableCommitException</a></strong></code> +<div class="block">Thrown during a transaction commit if durability guarantees cannot be met.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a></strong></code> +<div class="block">Thrown from a persist operation that was canceled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></strong></code> +<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="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></strong></code> +<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="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a></strong></code> +<div class="block">Thrown if a persist operation fails because lock acquisition timed out.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></strong></code> +<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> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">FetchDeadlockException.</span><code><strong><a href="../../../../com/amazon/carbonado/FetchDeadlockException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">FetchMultipleException.</span><code><strong><a href="../../../../com/amazon/carbonado/FetchMultipleException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">FetchTimeoutException.</span><code><strong><a href="../../../../com/amazon/carbonado/FetchTimeoutException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">RepositoryException.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">FetchNoneException.</span><code><strong><a href="../../../../com/amazon/carbonado/FetchNoneException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">FetchInterruptedException.</span><code><strong><a href="../../../../com/amazon/carbonado/FetchInterruptedException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">RepositoryException.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException</a></strong>()</code> +<div class="block">Converts RepositoryException into an appropriate PersistException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">RepositoryException.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException</a></strong>(java.lang.String message)</code> +<div class="block">Converts RepositoryException into an appropriate PersistException, prepending + the specified message.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">afterDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">afterInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully deleted via + tryDelete.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully inserted via + tryInsert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully updated via + tryUpdate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Transaction.</span><code><strong><a href="../../../../com/amazon/carbonado/Transaction.html#commit()">commit</a></strong>()</code> +<div class="block">If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#delete()">delete</a></strong>()</code> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#deleteAll()">deleteAll</a></strong>()</code> +<div class="block">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#deleteOne()">deleteOne</a></strong>()</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Transaction.</span><code><strong><a href="../../../../com/amazon/carbonado/Transaction.html#exit()">exit</a></strong>()</code> +<div class="block">Closes the current transaction, aborting all changes since the last + commit.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#insert()">insert</a></strong>()</code> +<div class="block">Inserts a new persistent value for this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Transaction.</span><code><strong><a href="../../../../com/amazon/carbonado/Transaction.html#preCommit()">preCommit</a></strong>()</code> +<div class="block">Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#truncate()">truncate</a></strong>()</code> +<div class="block">Attempts to quickly delete all Storables instances in this + Storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete</a></strong>()</code> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne()">tryDeleteOne</a></strong>()</code> +<div class="block">Deletes zero or one matching objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes zero or one matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert</a></strong>()</code> +<div class="block">Inserts a new persistent value for this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate</a></strong>()</code> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#update()">update</a></strong>()</code> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToBlob(java.lang.String)">adaptToBlob</a></strong>(java.lang.String text)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.Listener.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterDelete(S, java.lang.Object)">afterDelete</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + java.lang.Object state)</code> +<div class="block">Called right after a bogus storable has been successfully deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.Listener.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterInsert(S, java.lang.Object)">afterInsert</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called right after a sync'd storable has been successfully inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.Listener.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable, + java.lang.Object state)</code> +<div class="block">Called right after a sync'd storable has been successfully updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">ResyncCapability.Listener.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeDelete(S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable)</code> +<div class="block">Called before a bogus storable is to be deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">ResyncCapability.Listener.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeInsert(S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Called before a sync'd storable is to be inserted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">ResyncCapability.Listener.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeUpdate(S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Called before a sync'd storable is to be updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">ResyncCapability.Listener.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeUpdate(S, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> oldStorable, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a> newStorable)</code> +<div class="block">Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DelegateSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html#doTryDelete(S)">doTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DelegateSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html#doTryInsert(S)">doTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DelegateSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html#doTryUpdate(S)">doTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">MasterSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Returns a sequence value producer by name, or throw PersistException if not found.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">openOutputStream</a></strong>()</code> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><span class="strong">FileBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream()">openOutputStream</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">openOutputStream</a></strong>(long pos)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><span class="strong">FileBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream(long)">openOutputStream</a></strong>(long pos)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">openOutputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><span class="strong">FileBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream(long, int)">openOutputStream</a></strong>(long pos, + int bufferSize)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">openWriter</a></strong>()</code> +<div class="block">Returns a Writer for writing Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">StringClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openWriter()">openWriter</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openWriter()">openWriter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">StringClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">openWriter</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">StringClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openWriter(long, int)">openWriter</a></strong>(long pos, + int bufferSize)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openWriter(long, int)">openWriter</a></strong>(long pos, + int bufferSize)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ByteArrayBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#setLength(long)">setLength</a></strong>(long length)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StringClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#setLength(long)">setLength</a></strong>(long length)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">CharArrayClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#setLength(long)">setLength</a></strong>(long length)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#setLength(long)">setLength</a></strong>(long length)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">FileBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#setLength(long)">setLength</a></strong>(long length)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Clob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StringClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractClob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a></strong>(java.lang.String value, + java.nio.charset.Charset charset)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a></strong>(java.lang.String value, + java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractBlob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.lang.String)">setValue</a></strong>(java.lang.String value, + java.lang.String charsetName)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Blob.</span><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.lang.String)">setValue</a></strong>(java.lang.String value, + java.lang.String charsetName)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#deleteAll()">deleteAll</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne()">deleteOne</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne()">tryDeleteOne</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">JDBCConnectionCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toPersistException(java.lang.Throwable)">toPersistException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setBlobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +<tr class="rowColor"> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setClobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateBlob(com.amazon.carbonado.lob.Blob, com.amazon.carbonado.lob.Blob)">updateBlob</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> oldBlob, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> newBlob)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateClob(com.amazon.carbonado.lob.Clob, com.amazon.carbonado.lob.Clob)">updateClob</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> oldClob, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> newClob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">CheckpointCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#forceCheckpoint()">forceCheckpoint</a></strong>()</code> +<div class="block">Forces a checkpoint to run now, even if checkpointer is suspended or + disabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">CheckpointCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#sync()">sync</a></strong>()</code> +<div class="block">Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">SequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextDecimalValue()">nextDecimalValue</a></strong>()</code> +<div class="block">Returns the next decimal string value from the sequence, which remains + positive.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">AbstractSequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextDecimalValue()">nextDecimalValue</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">SequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextIntValue()">nextIntValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">SequenceValueGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#nextIntValue()">nextIntValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">AbstractSequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextIntValue()">nextIntValue</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">SequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextLongValue()">nextLongValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">SequenceValueGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#nextLongValue()">nextLongValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">SequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue</a></strong>(int radix, + int minLength)</code> +<div class="block">Returns the next numerical string value from the sequence, which remains + positive.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">AbstractSequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue</a></strong>(int radix, + int minLength)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SequenceValueGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#reset(int)">reset</a></strong>(int initialValue)</code> +<div class="block">Reset the sequence.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SequenceValueProducer.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#returnReservedValues()">returnReservedValues</a></strong>()</code> +<div class="block">Allow any unused reserved values to be returned for re-use.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SequenceValueGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#returnReservedValues()">returnReservedValues</a></strong>()</code> +<div class="block">Allow any unused reserved values to be returned for re-use.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">ExceptionTransformer.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toPersistException(java.lang.Throwable)">toPersistException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><span class="strong">ExceptionTransformer.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoPersistException(java.lang.Throwable)">transformIntoPersistException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterDelete(S, java.lang.Object)">afterDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterInsert(S, java.lang.Object)">afterInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<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"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#createNewBlob(int)">createNewBlob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Blob whose length is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<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"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#createNewClob(int)">createNewClob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Clob whose length is zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(com.amazon.carbonado.lob.Lob)">deleteLob</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(long)">deleteLob</a></strong>(long locator)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(long locator, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, java.io.InputStream)">setBlobValue</a></strong>(long locator, + java.io.InputStream data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(long locator, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, java.io.Reader)">setClobValue</a></strong>(long locator, + java.io.Reader data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> that throw <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#abortTxn(Txn)">abortTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Aborts and closes the given internal transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TransactionPair.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#commit()">commit</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#commitTxn(Txn)">commitTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Commits and closes the given internal transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TransactionPair.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#exit()">exit</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">TransactionPair.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#preCommit()">preCommit</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistException.html" target="_top">Frames</a></li> +<li><a href="PersistException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PersistInterruptedException.html b/apidocs/com/amazon/carbonado/class-use/PersistInterruptedException.html new file mode 100644 index 0000000..28d3e57 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PersistInterruptedException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PersistInterruptedException (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="Uses of Class com.amazon.carbonado.PersistInterruptedException (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><a href="../../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistInterruptedException.html" target="_top">Frames</a></li> +<li><a href="PersistInterruptedException.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"> +<h2 title="Uses of Class com.amazon.carbonado.PersistInterruptedException" class="title">Uses of Class<br>com.amazon.carbonado.PersistInterruptedException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.PersistInterruptedException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistInterruptedException.html" target="_top">Frames</a></li> +<li><a href="PersistInterruptedException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PersistMultipleException.html b/apidocs/com/amazon/carbonado/class-use/PersistMultipleException.html new file mode 100644 index 0000000..77dedca --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PersistMultipleException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PersistMultipleException (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="Uses of Class com.amazon.carbonado.PersistMultipleException (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><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistMultipleException.html" target="_top">Frames</a></li> +<li><a href="PersistMultipleException.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"> +<h2 title="Uses of Class com.amazon.carbonado.PersistMultipleException" class="title">Uses of Class<br>com.amazon.carbonado.PersistMultipleException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.PersistMultipleException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistMultipleException.html" target="_top">Frames</a></li> +<li><a href="PersistMultipleException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PersistNoneException.html b/apidocs/com/amazon/carbonado/class-use/PersistNoneException.html new file mode 100644 index 0000000..1cd7492 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PersistNoneException.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PersistNoneException (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="Uses of Class com.amazon.carbonado.PersistNoneException (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><a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistNoneException.html" target="_top">Frames</a></li> +<li><a href="PersistNoneException.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"> +<h2 title="Uses of Class com.amazon.carbonado.PersistNoneException" class="title">Uses of Class<br>com.amazon.carbonado.PersistNoneException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that throw <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteOne()">deleteOne</a></strong>()</code> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistNoneException.html" target="_top">Frames</a></li> +<li><a href="PersistNoneException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PersistTimeoutException.html b/apidocs/com/amazon/carbonado/class-use/PersistTimeoutException.html new file mode 100644 index 0000000..d13cf93 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PersistTimeoutException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PersistTimeoutException (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="Uses of Class com.amazon.carbonado.PersistTimeoutException (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><a href="../../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistTimeoutException.html" target="_top">Frames</a></li> +<li><a href="PersistTimeoutException.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"> +<h2 title="Uses of Class com.amazon.carbonado.PersistTimeoutException" class="title">Uses of Class<br>com.amazon.carbonado.PersistTimeoutException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.PersistTimeoutException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PersistTimeoutException.html" target="_top">Frames</a></li> +<li><a href="PersistTimeoutException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/PrimaryKey.html b/apidocs/com/amazon/carbonado/class-use/PrimaryKey.html new file mode 100644 index 0000000..7cb88ee --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/PrimaryKey.html @@ -0,0 +1,297 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.PrimaryKey (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="Uses of Class com.amazon.carbonado.PrimaryKey (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><a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PrimaryKey.html" target="_top">Frames</a></li> +<li><a href="PrimaryKey.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"> +<h2 title="Uses of Class com.amazon.carbonado.PrimaryKey" class="title">Uses of Class<br>com.amazon.carbonado.PrimaryKey</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with annotations of type <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></strong></code> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></strong></code> +<div class="block">Maps layout generations which are equivalent.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></strong></code> +<div class="block">Stored property joined to a <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with annotations of type <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></strong></code> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with annotations of type <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></strong></code> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> with annotations of type <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></strong></code> +<div class="block">Stores data for <a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><code>SequenceValueGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with annotations of type <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">PrimaryKey</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></strong></code> +<div class="block">Can be used internally by repositories for supporting Lobs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></strong></code> +<div class="block">Blocks stored here.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/PrimaryKey.html" target="_top">Frames</a></li> +<li><a href="PrimaryKey.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Query.Controller.html b/apidocs/com/amazon/carbonado/class-use/Query.Controller.html new file mode 100644 index 0000000..35e244f --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Query.Controller.html @@ -0,0 +1,559 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.Query.Controller (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="Uses of Interface com.amazon.carbonado.Query.Controller (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><a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Query.Controller.html" target="_top">Frames</a></li> +<li><a href="Query.Controller.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"> +<h2 title="Uses of Interface com.amazon.carbonado.Query.Controller" class="title">Uses of Interface<br>com.amazon.carbonado.Query.Controller</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that implement <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></strong></code> +<div class="block">Timeout controller, for aborting long running queries.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with parameters of type <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns true if any results are matched by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes zero or one matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">ControllerCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#apply(com.amazon.carbonado.Cursor, com.amazon.carbonado.Query.Controller)">apply</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> source, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a ControllerCursor depending on whether a controller instance is + passed in or not.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Query.Controller)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, com.amazon.carbonado.Query.Controller)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int, com.amazon.carbonado.Query.Controller)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir, + int maxArrayCapacity, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll(com.amazon.carbonado.Query.Controller)">countAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts all Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.ArraySortSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new ArraySortBuffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.MergeSortSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new MergeSortBuffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Does nothing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll(com.amazon.carbonado.Query.Controller)">fetchAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform a full scan of all Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Query.Controller.html" target="_top">Frames</a></li> +<li><a href="Query.Controller.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Query.Timeout.html b/apidocs/com/amazon/carbonado/class-use/Query.Timeout.html new file mode 100644 index 0000000..5e8a6a9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Query.Timeout.html @@ -0,0 +1,191 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Query.Timeout (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="Uses of Class com.amazon.carbonado.Query.Timeout (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><a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Query.Timeout.html" target="_top">Frames</a></li> +<li><a href="Query.Timeout.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"> +<h2 title="Uses of Class com.amazon.carbonado.Query.Timeout" class="title">Uses of Class<br>com.amazon.carbonado.Query.Timeout</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><span class="strong">Query.Timeout.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.Timeout.html#hours(long)">hours</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in hours.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><span class="strong">Query.Timeout.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.Timeout.html#micros(long)">micros</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in microseconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><span class="strong">Query.Timeout.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.Timeout.html#millis(long)">millis</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in milliseconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><span class="strong">Query.Timeout.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.Timeout.html#minutes(long)">minutes</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in minutes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><span class="strong">Query.Timeout.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.Timeout.html#nanos(long)">nanos</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in nanoseconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></td> +<td class="colLast"><span class="strong">Query.Timeout.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.Timeout.html#seconds(long)">seconds</a></strong>(long timeout)</code> +<div class="block">Return a new Timeout in seconds.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Query.Timeout.html" target="_top">Frames</a></li> +<li><a href="Query.Timeout.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Query.html b/apidocs/com/amazon/carbonado/class-use/Query.html new file mode 100644 index 0000000..1c9b06b --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Query.html @@ -0,0 +1,584 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.Query (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="Uses of Interface com.amazon.carbonado.Query (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><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Query.html" target="_top">Frames</a></li> +<li><a href="Query.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"> +<h2 title="Uses of Interface com.amazon.carbonado.Query" class="title">Uses of Interface<br>com.amazon.carbonado.Query</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#after(T)">after</a></strong>(T start)</code> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#and(java.lang.String)">and</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#not()">not</a></strong>()</code> +<div class="block">Returns a new query which produces all the results not supplied in this + query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#or(java.lang.String)">or</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> +<div class="block">Returns a copy of this query ordered by specific property values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> +<div class="block">Returns a copy of this query ordered by a specific property value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#query()">query</a></strong>()</code> +<div class="block">Query for all Storable instances in this Storage.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#query(com.amazon.carbonado.filter.Filter)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> filter)</code> +<div class="block">Query for Storable instances against an explicitly constructed filter + object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)">query</a></strong>(java.lang.String filter)</code> +<div class="block">Query for Storable instances against a filter expression.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Returns a copy of this Query with the next blank parameters filled in.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">AbstractQuery implements a small set of common Query methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Special query implementation that fetches nothing.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Abstract query implementation which uses a <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#after(T)">after</a></strong>(T start)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#after(T)">after</a></strong>(T start)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#and(java.lang.String)">and</a></strong>(java.lang.String filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index)</code> +<div class="block">Returns an open query if the given index supports query access.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#not()">not</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#not()">not</a></strong>()</code> +<div class="block">Returns a query that fetches everything, possibly in a specified order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#or(java.lang.String)">or</a></strong>(java.lang.String filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query()">query</a></strong>()</code> +<div class="block">Returns a new or cached query that fetches everything.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter)</code> +<div class="block">Returns a new or cached query for the given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(java.lang.String)">query</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new or cached query for the given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(boolean)">with</a></strong>(boolean value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(byte)">with</a></strong>(byte value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(char)">with</a></strong>(char value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(double)">with</a></strong>(double value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(float)">with</a></strong>(float value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(int)">with</a></strong>(int value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(long)">with</a></strong>(long value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(short)">with</a></strong>(short value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Throws an IllegalStateException unless no values passed in.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Query.html" target="_top">Frames</a></li> +<li><a href="Query.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Repository.html b/apidocs/com/amazon/carbonado/class-use/Repository.html new file mode 100644 index 0000000..01b8437 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Repository.html @@ -0,0 +1,708 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.Repository (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="Uses of Interface com.amazon.carbonado.Repository (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><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Repository.html" target="_top">Frames</a></li> +<li><a href="Repository.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"> +<h2 title="Uses of Interface com.amazon.carbonado.Repository" class="title">Uses of Interface<br>com.amazon.carbonado.Repository</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.map">com.amazon.carbonado.repo.map</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build()">build</a></strong>()</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootReference)</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootReference)</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">ResyncCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#getMasterRepository()">getMasterRepository</a></strong>()</code> +<div class="block">Returns the immediate master Repository, for manual comparison.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.SortedMap<java.lang.Object,<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>></code></td> +<td class="colLast"><span class="strong">GroupMembers.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/GroupMembers.html#getReadWriteMembers()">getReadWriteMembers</a></strong>()</code> +<div class="block">Returns members intended for read and write access.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with parameters of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html#handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)">handleRequest</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> request)</code> +<div class="block">Request handler for remote procedure implementation.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">StorableSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html#getRootRepository()">getRootRepository</a></strong>()</code> +<div class="block">Returns the root parent Repository that the Storable came from.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with parameters of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#LayoutFactory(com.amazon.carbonado.Repository)">LayoutFactory</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html#LayoutSync(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LayoutSync</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> source, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> destination)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> with parameters of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#AbstractBlob(com.amazon.carbonado.Repository)">AbstractBlob</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</code> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#AbstractClob(com.amazon.carbonado.Repository)">AbstractClob</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</code> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">RepositoryAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html#getRootRepository()">getRootRepository</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">IndexedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">IndexedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">JDBCRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">JDBCRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">LoggingRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">LoggingRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.map"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">MapRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">MapRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#newRepository()">newRepository</a></strong>()</code> +<div class="block">Convenience method to build a new MapRepository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">MapRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">ReplicatedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">ReplicatedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> with parameters of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name, + long initialValue, + int increment)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int, int)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name, + long initialValue, + int increment, + int reserveAmount)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a><Txn></strong></code> +<div class="block">Implements basic functionality required by a core Repository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">AbstractRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">BelatedRepositoryCreator.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createBogus()">createBogus</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">BelatedRepositoryCreator.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createReal()">createReal</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#BelatedStorageCreator(org.apache.commons.logging.Log, com.amazon.carbonado.Repository, java.lang.Class, int)">BelatedStorageCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> storableType, + int minRetryDelayMillis)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> locatorRepo)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructor parameters in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef, + int minRetryDelayMillis)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Repository.html" target="_top">Frames</a></li> +<li><a href="Repository.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> diff --git a/apidocs/com/amazon/carbonado/class-use/RepositoryBuilder.html b/apidocs/com/amazon/carbonado/class-use/RepositoryBuilder.html new file mode 100644 index 0000000..acdf753 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/RepositoryBuilder.html @@ -0,0 +1,437 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.RepositoryBuilder (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="Uses of Interface com.amazon.carbonado.RepositoryBuilder (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><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/RepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="RepositoryBuilder.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"> +<h2 title="Uses of Interface com.amazon.carbonado.RepositoryBuilder" class="title">Uses of Interface<br>com.amazon.carbonado.RepositoryBuilder</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.map">com.amazon.carbonado.repo.map</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that implement <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></strong></code> +<div class="block">Repository builder for the indexed repository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that return <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><span class="strong">IndexedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getWrappedRepository()">getWrappedRepository</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with parameters of type <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">IndexedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setWrappedRepository(com.amazon.carbonado.RepositoryBuilder)">setWrappedRepository</a></strong>(<a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> repoBuilder)</code> +<div class="block">Set the required wrapped respository, which must support the + <a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that implement <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></strong></code> +<div class="block">Builds a repository instance backed by a JDBC accessible database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> that implement <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></strong></code> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> that return <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><span class="strong">LoggingRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getActualRepositoryBuilder()">getActualRepositoryBuilder</a></strong>()</code> +<div class="block">Returns the Repository that all calls are wrapped to.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> with parameters of type <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LoggingRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setActualRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setActualRepositoryBuilder</a></strong>(<a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder)</code> +<div class="block">Set the Repository to wrap all calls to.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.map"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> in <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a> that implement <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></strong></code> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a> that implement <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></strong></code> +<div class="block">Repository builder for the replicated repository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a> that return <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><span class="strong">ReplicatedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getMasterRepositoryBuilder()">getMasterRepositoryBuilder</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><span class="strong">ReplicatedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getReplicaRepositoryBuilder()">getReplicaRepositoryBuilder</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a> with parameters of type <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ReplicatedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setMasterRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setMasterRepositoryBuilder</a></strong>(<a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> masterRepositoryBuilder)</code> +<div class="block">Set "master" respository to replicate from, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ReplicatedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setReplicaRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setReplicaRepositoryBuilder</a></strong>(<a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> replicaRepositoryBuilder)</code> +<div class="block">Set "replica" respository to replicate to, which is required.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that implement <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></strong></code> +<div class="block">Builder and configuration options for BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></strong></code> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef, + int minRetryDelayMillis)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + int minRetryDelayMillis)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/RepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="RepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/class-use/RepositoryException.html b/apidocs/com/amazon/carbonado/class-use/RepositoryException.html new file mode 100644 index 0000000..b3c7888 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/RepositoryException.html @@ -0,0 +1,1140 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.RepositoryException (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="Uses of Class com.amazon.carbonado.RepositoryException (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><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/RepositoryException.html" target="_top">Frames</a></li> +<li><a href="RepositoryException.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"> +<h2 title="Uses of Class com.amazon.carbonado.RepositoryException" class="title">Uses of Class<br>com.amazon.carbonado.RepositoryException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.map">com.amazon.carbonado.repo.map</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></strong></code> +<div class="block">A CorruptEncodingException is caused when decoding an encoded record fails.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a></strong></code> +<div class="block">Thrown from a fetch operation that was canceled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></strong></code> +<div class="block">Thrown if a fetch operation fails because lock acquisition timed out.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></strong></code> +<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="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">NonDurableCommitException</a></strong></code> +<div class="block">Thrown during a transaction commit if durability guarantees cannot be met.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></strong></code> +<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="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a></strong></code> +<div class="block">Thrown if a persist operation fails because it was selected to resolve a + deadlock.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></strong></code> +<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="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></strong></code> +<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="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a></strong></code> +<div class="block">Thrown from a persist operation that was canceled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></strong></code> +<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="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></strong></code> +<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="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a></strong></code> +<div class="block">Thrown if a persist operation fails because lock acquisition timed out.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></strong></code> +<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"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></strong></code> +<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> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build()">build</a></strong>()</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootReference)</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super S></code></td> +<td class="colLast"><span class="strong">TriggerFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/TriggerFactory.html#triggerFor(java.lang.Class)">triggerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Return an appropriate trigger for the given type, or null if none.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><R,D> <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><R,D></code></td> +<td class="colLast"><span class="strong">RemoteProcedureCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)">beginCall</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a><R,D> proc)</code> +<div class="block">Begins a call to execute the given procedure on a remote host.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Request.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#beginReply()">beginReply</a></strong>()</code> +<div class="block">Begin a reply after receiving all data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#execute()">execute</a></strong>()</code> +<div class="block">Executes the call without expecting a reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#executeAsync()">executeAsync</a></strong>()</code> +<div class="block">Executes the call without expecting a reply.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#fetchReply()">fetchReply</a></strong>()</code> +<div class="block">Executes the call and receive a reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Request.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#finish()">finish</a></strong>()</code> +<div class="block">Reply and immediately finish, without sending any data to caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#finish()">finish</a></strong>()</code> +<div class="block">Finish the reply.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#flush()">flush</a></strong>()</code> +<div class="block">Flushes all the data sent so far.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#flush()">flush</a></strong>()</code> +<div class="block">Flushes all the data sent so far.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfoCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><span class="strong">StorableInfoCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#getUserStorableTypeNames()">getUserStorableTypeNames</a></strong>()</code> +<div class="block">Returns an array of storable type class names for user-level storables + known to the repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html#handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)">handleRequest</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> request)</code> +<div class="block">Request handler for remote procedure implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Request.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receive()">receive</a></strong>()</code> +<div class="block">Receive data from caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Request.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receiveInto(java.util.Collection)">receiveInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>> c)</code> +<div class="block">Receive all remaining data from caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#reset()">reset</a></strong>()</code> +<div class="block">Reset the internal object stream of the reply, allowing cached + objects to get freed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#send(D)">send</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a> data)</code> +<div class="block">Send data to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#send(R)">send</a></strong>(<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a> data)</code> +<div class="block">Send reply data to the caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> cursor)</code> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(com.amazon.carbonado.Cursor)">sendAll</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> cursor)</code> +<div class="block">Reply with all data from the given cursor to the caller.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Call.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> iterable)</code> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a><<a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>></code></td> +<td class="colLast"><span class="strong">RemoteProcedure.Reply.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(java.lang.Iterable)">sendAll</a></strong>(java.lang.Iterable<? extends <a href="../../../../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> iterable)</code> +<div class="block">Reply with all data from the given iterable to the caller.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)">readLayoutFrom</a></strong>(java.io.InputStream in)</code> +<div class="block">Read a layout as written by <a href="../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)"><code>Layout.writeTo(java.io.OutputStream)</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">LayoutSync.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html#run()">run</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)">writeTo</a></strong>(java.io.OutputStream out)</code> +<div class="block">Write a layout to be read by <a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)"><code>LayoutFactory.readLayoutFrom(java.io.InputStream)</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#LayoutFactory(com.amazon.carbonado.Repository)">LayoutFactory</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#executor()">executor</a></strong>()</code> +<div class="block">Returns the executor in use by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorCache.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()">resetExecutor</a></strong>()</code> +<div class="block">Resets any cached reference to a query executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#resetExecutors()">resetExecutors</a></strong>()</code> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()"><code>StandardQuery.resetExecutor()</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()">setExecutor</a></strong>()</code> +<div class="block">Ensures that a cached query executor reference is available.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#setExecutors()">setExecutors</a></strong>()</code> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()"><code>StandardQuery.setExecutor()</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></code></td> +<td class="colLast"><span class="strong">RepositoryAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html#storageAccessFor(java.lang.Class)">storageAccessFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">IndexedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S>[]</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html#getIndexEntryAccessors(java.lang.Class)">getIndexEntryAccessors</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#repair(double)">repair</a></strong>(double desiredSpeed)</code> +<div class="block">Repairs the index by inserting missing entries and fixing + inconsistencies.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">JDBCRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">LoggingRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.map"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">MapRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">ReplicatedRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a><S></code></td> +<td class="colLast"><span class="strong">CompactionCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html#compact(java.lang.Class)">compact</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Compact an entire BDB backed storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">HotBackupCapability.Backup.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#endBackup()">endBackup</a></strong>()</code> +<div class="block">Resume normal operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><span class="strong">HotBackupCapability.Backup.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getDataFiles()">getDataFiles</a></strong>()</code> +<div class="block">Returns all the data files to be copied.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><span class="strong">HotBackupCapability.Backup.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getFiles()">getFiles</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use getDataFiles and getLogFiles</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">HotBackupCapability.Backup.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLastLogNumber()">getLastLogNumber</a></strong>()</code> +<div class="block">Can be called after a backup has been performed to find the last log file + that has been backed up.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><span class="strong">HotBackupCapability.Backup.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLogFiles()">getLogFiles</a></strong>()</code> +<div class="block">Returns all the transaction log files to be copied, in the exact + order in which they must be copied.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.DatabaseHook.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html#prepareForOpening(java.lang.Object)">prepareForOpening</a></strong>(java.lang.Object db)</code> +<div class="block">Called right before database is opened.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><span class="strong">HotBackupCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup()">startBackup</a></strong>()</code> +<div class="block">Starts the backup by disabling log file deletion.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><span class="strong">HotBackupCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup(boolean)">startBackup</a></strong>(boolean deleteOldLogFiles)</code> +<div class="block">Starts the backup by disabling log file deletion.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><span class="strong">HotBackupCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long)">startIncrementalBackup</a></strong>(long lastLogNumber)</code> +<div class="block">Starts an incremental backup.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><span class="strong">HotBackupCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long, boolean)">startIncrementalBackup</a></strong>(long lastLogNumber, + boolean deleteOldLogFiles)</code> +<div class="block">Starts an incremental backup.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#verify(java.io.PrintStream)">verify</a></strong>(java.io.PrintStream out)</code> +<div class="block">Opens the BDB environment, checks if it is corrupt, and then closes it.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">SequenceValueProducerPool.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#create(java.lang.String)">create</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">SequenceValueProducerPool.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">SequenceValueProducerPool.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#get(java.lang.String)">get</a></strong>(java.lang.String name)</code> +<div class="block">Returns a SequenceValueProducer instance for the given name, which is + lazily created and pooled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">SequenceCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name, + long initialValue, + int increment)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int, int)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name, + long initialValue, + int increment, + int reserveAmount)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></td> +<td class="colLast"><span class="strong">ExceptionTransformer.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toRepositoryException(java.lang.Throwable)">toRepositoryException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate repository + exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></td> +<td class="colLast"><span class="strong">ExceptionTransformer.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoRepositoryException(java.lang.Throwable)">transformIntoRepositoryException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#addTriggers(java.lang.Class, java.lang.Iterable)">addTriggers</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">AbstractRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#create(java.lang.Class)">create</a></strong>(java.lang.Class type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Called upon to create a new SequenceValueProducer instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Called upon to create a new Storage instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S></code></td> +<td class="colLast"><span class="strong">TriggerManagerCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html#getTriggerManagerFor(java.lang.Class)">getTriggerManagerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> locatorRepo)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#TriggerManager(java.lang.Class, java.lang.Iterable)">TriggerManager</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> that throw <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#close(boolean)">close</a></strong>(boolean suspend)</code> +<div class="block">Closes all transaction scopes.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/RepositoryException.html" target="_top">Frames</a></li> +<li><a href="RepositoryException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Sequence.html b/apidocs/com/amazon/carbonado/class-use/Sequence.html new file mode 100644 index 0000000..ab2d979 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Sequence.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Sequence (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="Uses of Class com.amazon.carbonado.Sequence (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><a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Sequence.html" target="_top">Frames</a></li> +<li><a href="Sequence.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"> +<h2 title="Uses of Class com.amazon.carbonado.Sequence" class="title">Uses of Class<br>com.amazon.carbonado.Sequence</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.Sequence</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Sequence.html" target="_top">Frames</a></li> +<li><a href="Sequence.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Storable.html b/apidocs/com/amazon/carbonado/class-use/Storable.html new file mode 100644 index 0000000..9bebc4c --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Storable.html @@ -0,0 +1,2131 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.Storable (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="Uses of Interface com.amazon.carbonado.Storable (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><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Storable.html" target="_top">Frames</a></li> +<li><a href="Storable.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"> +<h2 title="Uses of Interface com.amazon.carbonado.Storable" class="title">Uses of Interface<br>com.amazon.carbonado.Storable</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><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>></strong></code> +<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="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><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>></strong></code> +<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"><code>interface </code></td> +<td class="colLast"><code><strong><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>></strong></code> +<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> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super S></code></td> +<td class="colLast"><span class="strong">TriggerFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/TriggerFactory.html#triggerFor(java.lang.Class)">triggerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Return an appropriate trigger for the given type, or null if none.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">OptimisticLockException.</span><code><strong><a href="../../../../com/amazon/carbonado/OptimisticLockException.html#getStorable()">getStorable</a></strong>()</code> +<div class="block">Returns the Storable which was acted upon, or null if not available.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">CorruptEncodingException.</span><code><strong><a href="../../../../com/amazon/carbonado/CorruptEncodingException.html#getStorableWithPrimaryKey()">getStorableWithPrimaryKey</a></strong>()</code> +<div class="block">If the decoder was able to extract the primary key, it will be available in the + returned Storable.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">UnsupportedTypeException.</span><code><strong><a href="../../../../com/amazon/carbonado/UnsupportedTypeException.html#getType()">getType</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">CorruptEncodingException.</span><code><strong><a href="../../../../com/amazon/carbonado/CorruptEncodingException.html#setStorableWithPrimaryKey(com.amazon.carbonado.Storable)">setStorableWithPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s)</code> +<div class="block">If the decoder can at least extract the primary key, it should set it here.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object, java.lang.Object, com.amazon.carbonado.Storable)">OptimisticLockException</a></strong>(java.lang.Object expectedVersion, + java.lang.Object savedVersion, + <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object, com.amazon.carbonado.Storable, java.lang.Object)">OptimisticLockException</a></strong>(java.lang.Object savedVersion, + <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> s, + java.lang.Object newVersion)</code> +<div class="block">Construct exception for when new version was expected to have increased.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructor parameters in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/UnsupportedTypeException.html#UnsupportedTypeException(java.lang.String, java.lang.Class)">UnsupportedTypeException</a></strong>(java.lang.String message, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfoCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">ResyncCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)">resync</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">StorableInfoCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#isPropertySupported(java.lang.Class, java.lang.String)">isPropertySupported</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + java.lang.String name)</code> +<div class="block">Returns true if the given property exists and is supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">StorableInfoCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html#isSupported(java.lang.Class)">isSupported</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns true if the given storable type is supported.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Sort buffer implemented via a merge sort algorithm.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String, java.lang.Object...)">applyFilter</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor, + java.lang.Class<S> type, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Returns a Cursor that is filtered by the given filter expression and values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Cursor)">applyFilter</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S> filterValues, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Returns a Cursor that is filtered by the given Filter and FilterValues.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.util.Comparator<S></code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(java.util.List)">createComparator</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> properties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.util.Comparator<S></code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(com.amazon.carbonado.info.OrderedProperty...)">createComparator</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... properties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a logical 'and' test.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Base class for filter tree nodes that have a left and right child.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter which blocks any results from passing through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs an existence or non-existence test against a + join property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">An immutable tree structure representing a query result filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Assigns values to <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter which lets all results pass through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a logical 'or' test.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a relational test against a specific property + value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,R,P></strong></code> +<div class="block">Traverses a filter tree in its canonical order.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Prepends a join property to all properties of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a></strong>(java.lang.Class<T> type, + java.lang.String joinProperty)</code> +<div class="block">Prepends a join property to all properties of this filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><T></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">OrFilter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/OrFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><T></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">AndFilter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/AndFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><T></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><T></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a></strong>(java.lang.Class<S> type, + java.lang.String expression)</code> +<div class="block">Returns a cached filter instance that operates on the given type and + filter expression.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><S></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><S></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a cached filter instance that operates on the given type, which + allows all results to pass through.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen">DelegateStorableGenerator</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Generates and caches concrete implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + which delegate to <a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen">DetachedStorableFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Creates <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> instances which are basic data containers.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">MasterStorableGenerator</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + suitable for use by master repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Copies properties between otherwise incompatible Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Copies properties between otherwise incompatible Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> + types.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Basic implementation for <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()"><code>propertyMap()</code></a> method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a><S></code></td> +<td class="colLast"><span class="strong">StorablePropertyMap.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#createMap(java.lang.Class, S)">createMap</a></strong>(java.lang.Class<S> type, + S storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>org.cojen.classfile.ClassFile</code></td> +<td class="colLast"><span class="strong">CodeBuilderUtil.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#createStorableClassFile(org.cojen.util.ClassInjector, java.lang.Class, boolean, java.lang.String)">createStorableClassFile</a></strong>(org.cojen.util.ClassInjector ci, + java.lang.Class<S> type, + boolean isAbstract, + java.lang.String aSourcefileName)</code> +<div class="block">Define a classfile appropriate for most Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a><S></code></td> +<td class="colLast"><span class="strong">StorableCopier.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html#from(java.lang.Class)">from</a></strong>(java.lang.Class<S> source)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">StorableGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#getAbstractClass(java.lang.Class)">getAbstractClass</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">MasterStorableGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html#getAbstractClass(java.lang.Class, java.util.EnumSet)">getAbstractClass</a></strong>(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which + is fully thread-safe.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">DelegateStorableGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html#getDelegateClass(java.lang.Class, java.util.EnumSet)">getDelegateClass</a></strong>(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features)</code> +<div class="block">Delegate class has a constructor that accepts a <a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a> + instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>S</code></td> +<td class="colLast"><span class="strong">DetachedStorableFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html#newInstance()">newInstance</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a><<a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="type parameter in StorableCopier.From">S</a>,T></code></td> +<td class="colLast"><span class="strong">StorableCopier.From.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html#to(java.lang.Class)">to</a></strong>(java.lang.Class<T> target)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S></code></td> +<td class="colLast"><span class="strong">StorableIntrospector.</span><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)">examine</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Examines the given class and returns a StorableInfo describing it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</code> +<div class="block">Returns a canonical instance which has no chain.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses a chained property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)">parseNameDescriptor</a></strong>(java.lang.String desc, + <a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info)</code> +<div class="block">Parses an index descriptor and returns an index object.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinedType()">getJoinedType</a></strong>()</code> +<div class="block">Returns the type of property this is joined to, or null if not joined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">StorableIntrospector.</span><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#inferType(java.lang.Class)">inferType</a></strong>(java.lang.Class clazz)</code> +<div class="block">Examines a class and determines what Storable type it implements.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></strong></code> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></strong></code> +<div class="block">Maps layout generations which are equivalent.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></strong></code> +<div class="block">Stored property joined to a <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#reconstruct()">reconstruct</a></strong>()</code> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#reconstruct(java.lang.ClassLoader)">reconstruct</a></strong>(java.lang.ClassLoader loader)</code> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">AbstractQuery implements a small set of common Query methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Evaluates an index for how well it matches a query's desired filtering and + ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which delegates by executing a Query on a Storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutorFactory which produces executors which delegate via <a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>DelegatedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Special query implementation that fetches nothing.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and filters results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Evaluates an index for how well it matches a query's desired filtering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Analyzes a simple query specification and determines which index is best + suited for its execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which utilizes an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Produces unmodifiable lists of <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><code>orderings</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Evaluates an index for how well it matches a query's desired ordering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Complete rule-based query engine implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Performs all the actual work of executing a query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutors should be cached since expensive analysis is often required to build + them.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and sorts the results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Abstract query implementation which uses a <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Builds and caches StandardQuery instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Manages a set of <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a> objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of <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"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Analyzes a query specification and determines how it can be executed as a + union of smaller queries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#emptyList()">emptyList</a></strong>()</code> +<div class="block">Returns a canonical empty instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String...)">get</a></strong>(java.lang.Class<S> type, + java.lang.String... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String)">get</a></strong>(java.lang.Class<S> type, + java.lang.String property)</code> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></code></td> +<td class="colLast"><span class="strong">RepositoryAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html#storageAccessFor(java.lang.Class)">storageAccessFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Extension of GenericEncodingStrategy that allows for compression.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Allows codecs to be defined for storables that have a custom encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Used for decoding different generations of Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Creates custom raw search keys for <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Supports encoding and decoding of storables.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">RawStorableGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html#getAbstractClass(java.lang.Class, boolean)">getAbstractClass</a></strong>(java.lang.Class<S> type, + boolean isMaster)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">GenericInstanceFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">GenericInstanceFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[])">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">GenericInstanceFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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> support, + byte[] key, + byte[] value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.InstanceFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[], com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key, + byte[] value, + <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.InstanceFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getCompressionType(java.lang.Class)">getCompressionType</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Optionally return additional information regarding storable encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null to let repository decide what the name should be.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the preferred storage/database name for the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null to let repository decide what the name should be.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></strong></code> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S>[]</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html#getIndexEntryAccessors(java.lang.Class)">getIndexEntryAccessors</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Comparator<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getComparator()">getComparator</a></strong>()</code> +<div class="block">Returns a comparator for ordering index entries.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Sets all the properties of the given index entry, using the applicable + properties of the given master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as + needed by JDBCRepository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as needed by JDBCRepository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S></code></td> +<td class="colLast"><span class="strong">JDBCStorableIntrospector.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html#examine(java.lang.Class, javax.sql.DataSource, java.lang.String, java.lang.String)">examine</a></strong>(java.lang.Class<S> type, + javax.sql.DataSource ds, + java.lang.String catalog, + java.lang.String schema)</code> +<div class="block">Examines the given class and returns a JDBCStorableInfo describing it.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that implement <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></strong></code> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a><S></code></td> +<td class="colLast"><span class="strong">CompactionCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html#compact(java.lang.Class)">compact</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Compact an entire BDB backed storage.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with type arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabasePageSize(java.lang.Integer, java.lang.Class)">setDatabasePageSize</a></strong>(java.lang.Integer bytes, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Sets the desired page size for a given type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Generic one-shot Storage creator which supports late object creation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></strong></code> +<div class="block">Can be used internally by repositories for supporting Lobs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></strong></code> +<div class="block">Blocks stored here.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Called upon to create a new Storage instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)">getSupportTrigger</a></strong>(java.lang.Class<S> type, + int blockSize)</code> +<div class="block">Returns a Trigger for binding to this LobEngine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S></code></td> +<td class="colLast"><span class="strong">TriggerManagerCapability.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html#getTriggerManagerFor(java.lang.Class)">getTriggerManagerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>boolean</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#hasLobs(java.lang.Class)">hasLobs</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides access to the generated storable reference class and utility + methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">A SyntheticStorableReference defines new kinds of Storables from an existing + master storable.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#build()">build</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#build()">build</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">build</a></strong>()</code> +<div class="block">Convenience method to generate the class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Comparator<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getComparator()">getComparator</a></strong>()</code> +<div class="block">Returns a comparator for ordering storable reference instances.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Comparator<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getComparator()">getComparator</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getReferenceClass()">getReferenceClass</a></strong>()</code> +<div class="block">Returns the generated storable reference class.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getStorableClass()">getStorableClass</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getStorableClass()">getStorableClass</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()">getStorableClass</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> with parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Sets all the properties of the given reference, using the applicable + properties of the given master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given reference.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Returns true if the properties of the given reference match those + contained in the master, excluding any version property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> with type parameters of type <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#register(java.lang.Class, com.amazon.carbonado.Cursor)">register</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#unregister(java.lang.Class, com.amazon.carbonado.Cursor)">unregister</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Unregisters a previously registered cursor.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Storable.html" target="_top">Frames</a></li> +<li><a href="Storable.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Storage.html b/apidocs/com/amazon/carbonado/class-use/Storage.html new file mode 100644 index 0000000..2d2dda1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Storage.html @@ -0,0 +1,346 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.Storage (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="Uses of Interface com.amazon.carbonado.Storage (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><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Storage.html" target="_top">Frames</a></li> +<li><a href="Storage.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"> +<h2 title="Uses of Interface com.amazon.carbonado.Storage" class="title">Uses of Interface<br>com.amazon.carbonado.Storage</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a> in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, com.amazon.carbonado.Query.Controller)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir, + int maxArrayCapacity)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int, com.amazon.carbonado.Query.Controller)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir, + int maxArrayCapacity, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><span class="strong">StorageAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#storageDelegate(com.amazon.carbonado.info.StorableIndex)">storageDelegate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> index)</code> +<div class="block">If the given index is not directly supported by storage, queries should + be delegated.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">DelegatedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)">DelegatedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> executor)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#DelegatedQueryExecutorFactory(com.amazon.carbonado.Storage)">DelegatedQueryExecutorFactory</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> rootStorage)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that return <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><?></code></td> +<td class="colLast"><span class="strong">IndexEntryAccessor.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getIndexEntryStorage()">getIndexEntryStorage</a></strong>()</code> +<div class="block">Returns the index entry storage.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#create(java.lang.Class)">create</a></strong>(java.lang.Class type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>></code></td> +<td class="colLast"><span class="strong">BelatedStorageCreator.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#createBogus()">createBogus</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>></code></td> +<td class="colLast"><span class="strong">BelatedStorageCreator.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#createReal()">createReal</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Called upon to create a new Storage instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected java.util.Collection<<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#allStorage()">allStorage</a></strong>()</code> +<div class="block">Returns all available Storage instances.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Storage.html" target="_top">Frames</a></li> +<li><a href="Storage.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> diff --git a/apidocs/com/amazon/carbonado/class-use/SupportException.html b/apidocs/com/amazon/carbonado/class-use/SupportException.html new file mode 100644 index 0000000..d9a4a82 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/SupportException.html @@ -0,0 +1,713 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.SupportException (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="Uses of Class com.amazon.carbonado.SupportException (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><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/SupportException.html" target="_top">Frames</a></li> +<li><a href="SupportException.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"> +<h2 title="Uses of Class com.amazon.carbonado.SupportException" class="title">Uses of Class<br>com.amazon.carbonado.SupportException</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></strong></code> +<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"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></strong></code> +<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="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></strong></code> +<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> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom</a></strong>(java.io.InputStream in)</code> +<div class="block">Restores property values and states as encoded by <a href="../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)"><code>Storable.writeTo(java.io.OutputStream)</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">Storable.</span><code><strong><a href="../../../../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo</a></strong>(java.io.OutputStream out)</code> +<div class="block">Serializes property values and states for temporary storage or for + network transfer.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">MasterStorableGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html#getAbstractClass(java.lang.Class, java.util.EnumSet)">getAbstractClass</a></strong>(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which + is fully thread-safe.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">DelegateStorableGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html#getDelegateClass(java.lang.Class, java.util.EnumSet)">getDelegateClass</a></strong>(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features)</code> +<div class="block">Delegate class has a constructor that accepts a <a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a> + instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><span class="strong">CodeBuilderUtil.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#incrementVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc)">incrementVersion</a></strong>(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type)</code> +<div class="block">Generates code to increment a version property value, already on the stack.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><span class="strong">CodeBuilderUtil.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#initialVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)">initialVersion</a></strong>(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type, + int value)</code> +<div class="block">Generates code to push an initial version property value on the stack.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html#DetachedStorableFactory(java.lang.Class)">DetachedStorableFactory</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="type parameter in DetachedStorableFactory">S</a>> type)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><span class="strong">LayoutProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType()">getPropertyType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><span class="strong">LayoutProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType(java.lang.ClassLoader)">getPropertyType</a></strong>(java.lang.ClassLoader loader)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#reconstruct()">reconstruct</a></strong>()</code> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#reconstruct(java.lang.ClassLoader)">reconstruct</a></strong>(java.lang.ClassLoader loader)</code> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></code></td> +<td class="colLast"><span class="strong">RepositoryAccess.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html#storageAccessFor(java.lang.Class)">storageAccessFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)">buildDataDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + int generation, + org.cojen.classfile.Label altGenerationHandler, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int)">buildDataEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + int generation)</code> +<div class="block">Generates bytecode instructions to encode properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable)">buildKeyDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable, org.cojen.classfile.LocalVariable)">buildKeyEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + org.cojen.classfile.LocalVariable partialStartVar, + org.cojen.classfile.LocalVariable partialEndVar)</code> +<div class="block">Generates bytecode instructions to encode properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable)">buildSerialDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties and their states.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[])">buildSerialEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> +<div class="block">Generates bytecode instructions to encode properties and their + states.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty)">checkSupport</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> property)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty[])">checkSupport</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><span class="strong">GzipCompressor.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GzipCompressor.html#compress(byte[], int)">compress</a></strong>(byte[] value, + int prefix)</code> +<div class="block">Encodes into compressed form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">RawStorableGenerator.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html#getAbstractClass(java.lang.Class, boolean)">getAbstractClass</a></strong>(java.lang.Class<S> type, + boolean isMaster)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null to let repository decide what the name should be.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the preferred storage/database name for the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null to let repository decide what the name should be.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#pushRawSupport(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable)">pushRawSupport</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable instanceVar)</code> +<div class="block">Generates code to push RawSupport instance to the stack.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><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="colLast"><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S></code></td> +<td class="colLast"><span class="strong">JDBCStorableIntrospector.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html#examine(java.lang.Class, javax.sql.DataSource, java.lang.String, java.lang.String)">examine</a></strong>(java.lang.Class<S> type, + javax.sql.DataSource ds, + java.lang.String catalog, + java.lang.String schema)</code> +<div class="block">Examines the given class and returns a JDBCStorableInfo describing it.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#create(java.lang.Class)">create</a></strong>(java.lang.Class type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><span class="strong">BelatedRepositoryCreator.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createReal()">createReal</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>></code></td> +<td class="colLast"><span class="strong">BelatedStorageCreator.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#createReal()">createReal</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">StoragePool.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a> in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that throw <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#build()">build</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#build()">build</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">build</a></strong>()</code> +<div class="block">Convenience method to generate the class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#prepare()">prepare</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#prepare()">prepare</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()">prepare</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/SupportException.html" target="_top">Frames</a></li> +<li><a href="SupportException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Transaction.html b/apidocs/com/amazon/carbonado/class-use/Transaction.html new file mode 100644 index 0000000..ac8324d --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Transaction.html @@ -0,0 +1,414 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.Transaction (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="Uses of Interface com.amazon.carbonado.Transaction (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><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Transaction.html" target="_top">Frames</a></li> +<li><a href="Transaction.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"> +<h2 title="Uses of Interface com.amazon.carbonado.Transaction" class="title">Uses of Interface<br>com.amazon.carbonado.Transaction</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()">enterTransaction</a></strong>()</code> +<div class="block">Causes the current thread to enter a transaction scope.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">Repository.</span><code><strong><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with parameters of type <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction()">enterTransaction</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> that implement <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></strong></code> +<div class="block">Pairs two transaction together into one.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> that return <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#enter(com.amazon.carbonado.IsolationLevel)">enter</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enters a new transaction scope which becomes the active transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><span class="strong">TransactionScope.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#enterTop(com.amazon.carbonado.IsolationLevel)">enterTop</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enters a new top-level transaction scope which becomes the active + transaction.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> with parameters of type <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TransactionMonitor.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html#entered(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">entered</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> entered, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent)</code> +<div class="block">Called by a thread which has just entered a transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TransactionMonitor.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html#exited(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">exited</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> exited, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> active)</code> +<div class="block">Called by a thread which has just exited a transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#selectIsolationLevel(com.amazon.carbonado.Transaction, com.amazon.carbonado.IsolationLevel)">selectIsolationLevel</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns supported isolation level, which may be higher.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> with parameters of type <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#TransactionPair(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">TransactionPair</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> primaryTransaction, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> secondaryTransaction)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Transaction.html" target="_top">Frames</a></li> +<li><a href="Transaction.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Trigger.Abort.html b/apidocs/com/amazon/carbonado/class-use/Trigger.Abort.html new file mode 100644 index 0000000..2dff17c --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Trigger.Abort.html @@ -0,0 +1,184 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Trigger.Abort (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="Uses of Class com.amazon.carbonado.Trigger.Abort (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><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Trigger.Abort.html" target="_top">Frames</a></li> +<li><a href="Trigger.Abort.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"> +<h2 title="Uses of Class com.amazon.carbonado.Trigger.Abort" class="title">Uses of Class<br>com.amazon.carbonado.Trigger.Abort</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()">abortTry</a></strong>()</code> +<div class="block">Call to quickly abort a "try" operation, returning false to the + caller.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></code></td> +<td class="colLast"><span class="strong">Trigger.Abort.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.Abort.html#withStackTrace()">withStackTrace</a></strong>()</code> +<div class="block">Returns this exception but with a fresh stack trace.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that throw <a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></code></td> +<td class="colLast"><span class="strong">Trigger.</span><code><strong><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()">abortTry</a></strong>()</code> +<div class="block">Call to quickly abort a "try" operation, returning false to the + caller.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Trigger.Abort.html" target="_top">Frames</a></li> +<li><a href="Trigger.Abort.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Trigger.html b/apidocs/com/amazon/carbonado/class-use/Trigger.html new file mode 100644 index 0000000..d0f4dde --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Trigger.html @@ -0,0 +1,341 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Trigger (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="Uses of Class com.amazon.carbonado.Trigger (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><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Trigger.html" target="_top">Frames</a></li> +<li><a href="Trigger.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"> +<h2 title="Uses of Class com.amazon.carbonado.Trigger" class="title">Uses of Class<br>com.amazon.carbonado.Trigger</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super S></code></td> +<td class="colLast"><span class="strong">TriggerFactory.</span><code><strong><a href="../../../../com/amazon/carbonado/TriggerFactory.html#triggerFor(java.lang.Class)">triggerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Return an appropriate trigger for the given type, or null if none.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with parameters of type <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#addTrigger(com.amazon.carbonado.Trigger)">addTrigger</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> trigger)</code> +<div class="block">Register a trigger which will be called for overridden methods in the given + trigger implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../com/amazon/carbonado/Storage.html#removeTrigger(com.amazon.carbonado.Trigger)">removeTrigger</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> trigger)</code> +<div class="block">Remove a trigger which was registered earlier.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a> in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a> in <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a><S></strong></code> +<div class="block">Trigger which is invoked as storables get re-sync'd.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a> in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that return <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><span class="strong">TriggerSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getDeleteTrigger()">getDeleteTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all delete operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><span class="strong">TriggerSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getInsertTrigger()">getInsertTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all insert operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><span class="strong">TriggerSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getLoadTrigger()">getLoadTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all load and fetch operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><span class="strong">TriggerSupport.</span><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getUpdateTrigger()">getUpdateTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all update operations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getDeleteTrigger()">getDeleteTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for delete operations, or null if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getInsertTrigger()">getInsertTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for insert operations, or null if + none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getLoadTrigger()">getLoadTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for load operations, or null if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)">getSupportTrigger</a></strong>(java.lang.Class<S> type, + int blockSize)</code> +<div class="block">Returns a Trigger for binding to this LobEngine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getUpdateTrigger()">getUpdateTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for update operations, or null if + none.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#addTrigger(com.amazon.carbonado.Trigger)">addTrigger</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#removeTrigger(com.amazon.carbonado.Trigger)">removeTrigger</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Trigger.html" target="_top">Frames</a></li> +<li><a href="Trigger.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> diff --git a/apidocs/com/amazon/carbonado/class-use/TriggerFactory.html b/apidocs/com/amazon/carbonado/class-use/TriggerFactory.html new file mode 100644 index 0000000..31f58ed --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/TriggerFactory.html @@ -0,0 +1,250 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.TriggerFactory (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="Uses of Interface com.amazon.carbonado.TriggerFactory (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><a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/TriggerFactory.html" target="_top">Frames</a></li> +<li><a href="TriggerFactory.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"> +<h2 title="Uses of Interface com.amazon.carbonado.TriggerFactory" class="title">Uses of Interface<br>com.amazon.carbonado.TriggerFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>></code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a></strong>()</code> +<div class="block">Returns all the TriggerFactories which were added.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with parameters of type <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a></strong>(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> +<div class="block">Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">RepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></strong>(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> +<div class="block">Remove a TriggerFactory which was added earlier.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return types with arguments of type <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>></code></td> +<td class="colLast"><span class="strong">AbstractRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">AbstractRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a></strong>(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">AbstractRepositoryBuilder.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></strong>(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with type arguments of type <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">TriggerManager.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#addTriggers(java.lang.Class, java.lang.Iterable)">addTriggers</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructor parameters in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with type arguments of type <a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#TriggerManager(java.lang.Class, java.lang.Iterable)">TriggerManager</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/TriggerFactory.html" target="_top">Frames</a></li> +<li><a href="TriggerFactory.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> diff --git a/apidocs/com/amazon/carbonado/class-use/UniqueConstraintException.html b/apidocs/com/amazon/carbonado/class-use/UniqueConstraintException.html new file mode 100644 index 0000000..a61288e --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/UniqueConstraintException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.UniqueConstraintException (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="Uses of Class com.amazon.carbonado.UniqueConstraintException (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><a href="../../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/UniqueConstraintException.html" target="_top">Frames</a></li> +<li><a href="UniqueConstraintException.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"> +<h2 title="Uses of Class com.amazon.carbonado.UniqueConstraintException" class="title">Uses of Class<br>com.amazon.carbonado.UniqueConstraintException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.UniqueConstraintException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/UniqueConstraintException.html" target="_top">Frames</a></li> +<li><a href="UniqueConstraintException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/UnsupportedTypeException.html b/apidocs/com/amazon/carbonado/class-use/UnsupportedTypeException.html new file mode 100644 index 0000000..40ed5bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/UnsupportedTypeException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.UnsupportedTypeException (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="Uses of Class com.amazon.carbonado.UnsupportedTypeException (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><a href="../../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/UnsupportedTypeException.html" target="_top">Frames</a></li> +<li><a href="UnsupportedTypeException.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"> +<h2 title="Uses of Class com.amazon.carbonado.UnsupportedTypeException" class="title">Uses of Class<br>com.amazon.carbonado.UnsupportedTypeException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.UnsupportedTypeException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/UnsupportedTypeException.html" target="_top">Frames</a></li> +<li><a href="UnsupportedTypeException.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> diff --git a/apidocs/com/amazon/carbonado/class-use/Version.html b/apidocs/com/amazon/carbonado/class-use/Version.html new file mode 100644 index 0000000..8bdd397 --- /dev/null +++ b/apidocs/com/amazon/carbonado/class-use/Version.html @@ -0,0 +1,279 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.Version (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="Uses of Class com.amazon.carbonado.Version (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><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Version.html" target="_top">Frames</a></li> +<li><a href="Version.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"> +<h2 title="Uses of Class com.amazon.carbonado.Version" class="title">Uses of Class<br>com.amazon.carbonado.Version</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a> in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with annotations of type <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">StoredLayoutProperty.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredPropertyLayout instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">StoredLayout.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredTypeLayout instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">StoredLayoutEquivalence.</span><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getVersionNumber()">getVersionNumber</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a> in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> with annotations of type <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">StoredIndexInfo.</span><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a> in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with annotations of type <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><span class="strong">StoredDatabaseInfo.</span><code><strong><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredDatabaseInfo instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a> in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> with annotations of type <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">StoredSequence.</span><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a> in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with annotations of type <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Version</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><span class="strong">StoredLob.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><span class="strong">StoredLob.Block.</span><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/class-use/Version.html" target="_top">Frames</a></li> +<li><a href="Version.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> diff --git a/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html b/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html new file mode 100644 index 0000000..0b5234b --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/ConstraintDefinition.html @@ -0,0 +1,288 @@ +<!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>ConstraintDefinition (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="ConstraintDefinition (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/ConstraintDefinition.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/ConstraintDefinition.html" target="_top">Frames</a></li> +<li><a href="ConstraintDefinition.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.constraint</div> +<h2 title="Annotation Type ConstraintDefinition" class="title">Annotation Type ConstraintDefinition</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=ANNOTATION_TYPE) +public @interface <span class="strong">ConstraintDefinition</span></pre> +<div class="block">Allows annotations to be defined that restrict property values. The + annotation is just a pointer to a constraint checking class. If the + constraint class is not explicitly provided, it defaults to a static inner + class named "Constraint" in the annotation itself. + + <p>The constraint class must have a public constructor that accepts the + annotation that has the ConstraintDefinition annotation. It must also define + several "constrain" methods which perform constraint checks on specific + property types. + <p> + Example integer constraint: + <pre> + @Documented + <b>@Retention(RetentionPolicy.RUNTIME)</b> + <b>@Target(ElementType.METHOD)</b> + <b>@ConstraintDefinition</b> + public @interface IntegerConstraint { + int min() default Integer.MIN_VALUE; + + int max() default Integer.MAX_VALUE; + + public static class Constraint { + private final String propertyName; + private final int min; + private final int max; + + // Constructor may throw a MalformedTypeException if + // params supplied by annotation are illegal. + + /** + * @param type optional type of object that contains the constrained property + * @param propertyName name of property with constraint + * @param annotation specific annotation that binds to this constraint class + */ + public Constraint(Class type, String propertyName, IntegerConstraint annotation) { + this.propertyName = propertyName; + this.min = annotation.min(); + this.max = annotation.max(); + } + + // Define a constrain method for each supported property type. + + /** + * @param propertyValue specific value to constrain + */ + public void constrain(int propertyValue) throws IllegalArgumentException { + if (propertyValue < min || propertyValue > max) { + throw new IllegalArgumentException + ("Value for \"" + propertyName + "\" must be in range " + + min + ".." + max + ": " + propertyValue); + } + } + } + } + </pre> + + The newly defined integer constraint can be applied to property mutators. + + <pre> + public interface UserInfo extends Storable { + ... + + int getAge(); + // Constraint is called before setting age. + <b>@IntegerConstraint(min=0, max=120)</b> + void setAge(int value); + } + </pre></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"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html#implementation()">implementation</a></strong></code> +<div class="block">Specify class which will perform constraint checking.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="implementation()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>implementation</h4> +<pre>public abstract java.lang.Class implementation</pre> +<div class="block">Specify class which will perform constraint checking. Must have a public + constructor with the signature + <code>(Class type, String propertyName, <i>Annotation</i>)</code>, + where <code><i>Annotation</i></code> refers to the annotation with the + constraint definition. + + <p>The implementation class need not be explicitly specified. By + default, the constraint class must be a static inner class of the + annotation, named "Constraint".</div> +<dl> +<dt>Default:</dt> +<dd>void.class</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/ConstraintDefinition.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/ConstraintDefinition.html" target="_top">Frames</a></li> +<li><a href="ConstraintDefinition.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html new file mode 100644 index 0000000..2ec9cdf --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.Constraint.html @@ -0,0 +1,330 @@ +<!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>FloatConstraint.Constraint (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="FloatConstraint.Constraint (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/FloatConstraint.Constraint.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/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="FloatConstraint.Constraint.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><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.constraint</div> +<h2 title="Class FloatConstraint.Constraint" class="title">Class FloatConstraint.Constraint</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.constraint.FloatConstraint.Constraint</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">FloatConstraint.Constraint</span> +extends java.lang.Object</pre> +<div class="block">Constraint implementation for <a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>FloatConstraint</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/constraint/FloatConstraint.Constraint.html#FloatConstraint.Constraint(java.lang.Class, java.lang.String, double, double, double[], double[])">FloatConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + double min, + double max, + double[] allowed, + double[] disallowed)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#FloatConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.FloatConstraint)">FloatConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a> ann)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#constrain(char)">constrain</a></strong>(char propertyValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#constrain(char[])">constrain</a></strong>(char[] propertyValue)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#constrain(java.lang.CharSequence)">constrain</a></strong>(java.lang.CharSequence propertyValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#constrain(double)">constrain</a></strong>(double propertyValue)</code> </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> +</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="FloatConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.FloatConstraint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FloatConstraint.Constraint</h4> +<pre>public FloatConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the constrained property</dd><dd><code>propertyName</code> - name of property with constraint</dd><dd><code>ann</code> - specific annotation that binds to this constraint class</dd></dl> +</li> +</ul> +<a name="FloatConstraint.Constraint(java.lang.Class, java.lang.String, double, double, double[], double[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FloatConstraint.Constraint</h4> +<pre>public FloatConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + double min, + double max, + double[] allowed, + double[] disallowed)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the constrained property</dd><dd><code>propertyName</code> - name of property with constraint</dd><dd><code>min</code> - minimum allowed value</dd><dd><code>max</code> - maximum allowed value</dd><dd><code>allowed</code> - optional set of allowed values</dd><dd><code>disallowed</code> - optional set of disallowed values</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="constrain(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(double propertyValue)</pre> +</li> +</ul> +<a name="constrain(java.lang.CharSequence)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(java.lang.CharSequence propertyValue)</pre> +</li> +</ul> +<a name="constrain(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(char propertyValue)</pre> +</li> +</ul> +<a name="constrain(char[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(char[] propertyValue)</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/FloatConstraint.Constraint.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/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="FloatConstraint.Constraint.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><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> diff --git a/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html new file mode 100644 index 0000000..2df53d5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/FloatConstraint.html @@ -0,0 +1,289 @@ +<!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>FloatConstraint (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="FloatConstraint (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/FloatConstraint.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/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/FloatConstraint.html" target="_top">Frames</a></li> +<li><a href="FloatConstraint.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.constraint</div> +<h2 title="Annotation Type FloatConstraint" class="title">Annotation Type FloatConstraint</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">@ConstraintDefinition</a> +public @interface <span class="strong">FloatConstraint</span></pre> +<div class="block">Limits the value of a property to be a member of a specific set. The + property value may be a boxed or unboxed float, double, String, + CharSequence, char, Character, or character array. If the property value is + outside the set, an IllegalArgumentException is thrown. + + <p>Example:<pre> + public interface PolarCoordinate extends Storable { + double getTheta(); + <b>@FloatConstraint(min=0, max=Math.PI * 2, disallowed=Double.NaN)</b> + void setTheta(double radians); + + ... + } + </pre></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/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>IntegerConstraint</code></a>, +<a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>TextConstraint</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html#allowed()">allowed</a></strong></code> +<div class="block">Specific allowed values for property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html#disallowed()">disallowed</a></strong></code> +<div class="block">Specific disallowed values for property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html#max()">max</a></strong></code> +<div class="block">Specify maximum allowed value for float/double property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html#min()">min</a></strong></code> +<div class="block">Specify minimum allowed value for float/double property.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="allowed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allowed</h4> +<pre>public abstract double[] allowed</pre> +<div class="block">Specific allowed values for property. Default is unlimited.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="disallowed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disallowed</h4> +<pre>public abstract double[] disallowed</pre> +<div class="block">Specific disallowed values for property. Default is none.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="min()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>min</h4> +<pre>public abstract double min</pre> +<div class="block">Specify minimum allowed value for float/double property. Default is unlimited.</div> +<dl> +<dt>Default:</dt> +<dd>-1d/0d</dd> +</dl> +</li> +</ul> +<a name="max()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>max</h4> +<pre>public abstract double max</pre> +<div class="block">Specify maximum allowed value for float/double property. Default is unlimited.</div> +<dl> +<dt>Default:</dt> +<dd>1d/0d</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/FloatConstraint.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/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/FloatConstraint.html" target="_top">Frames</a></li> +<li><a href="FloatConstraint.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html new file mode 100644 index 0000000..a5baafb --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html @@ -0,0 +1,343 @@ +<!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>IntegerConstraint.Constraint (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="IntegerConstraint.Constraint (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/IntegerConstraint.Constraint.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/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="IntegerConstraint.Constraint.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><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.constraint</div> +<h2 title="Class IntegerConstraint.Constraint" class="title">Class IntegerConstraint.Constraint</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.constraint.IntegerConstraint.Constraint</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">IntegerConstraint.Constraint</span> +extends java.lang.Object</pre> +<div class="block">Constraint implementation for <a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>IntegerConstraint</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/constraint/IntegerConstraint.Constraint.html#IntegerConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.IntegerConstraint)">IntegerConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a> ann)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#IntegerConstraint.Constraint(java.lang.Class, java.lang.String, long, long, long[], long[])">IntegerConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + long min, + long max, + long[] allowed, + long[] disallowed)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(char)">constrain</a></strong>(char propertyValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(char[])">constrain</a></strong>(char[] propertyValue)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(java.lang.CharSequence)">constrain</a></strong>(java.lang.CharSequence propertyValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(double)">constrain</a></strong>(double propertyValue)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(long)">constrain</a></strong>(long propertyValue)</code> </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> +</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="IntegerConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.IntegerConstraint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IntegerConstraint.Constraint</h4> +<pre>public IntegerConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the constrained property</dd><dd><code>propertyName</code> - name of property with constraint</dd><dd><code>ann</code> - specific annotation that binds to this constraint class</dd></dl> +</li> +</ul> +<a name="IntegerConstraint.Constraint(java.lang.Class, java.lang.String, long, long, long[], long[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IntegerConstraint.Constraint</h4> +<pre>public IntegerConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + long min, + long max, + long[] allowed, + long[] disallowed)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the constrained property</dd><dd><code>propertyName</code> - name of property with constraint</dd><dd><code>min</code> - minimum allowed value</dd><dd><code>max</code> - maximum allowed value</dd><dd><code>allowed</code> - optional set of allowed values</dd><dd><code>disallowed</code> - optional set of disallowed values</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="constrain(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(long propertyValue)</pre> +</li> +</ul> +<a name="constrain(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(double propertyValue)</pre> +</li> +</ul> +<a name="constrain(java.lang.CharSequence)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(java.lang.CharSequence propertyValue)</pre> +</li> +</ul> +<a name="constrain(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(char propertyValue)</pre> +</li> +</ul> +<a name="constrain(char[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(char[] propertyValue)</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/IntegerConstraint.Constraint.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/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="IntegerConstraint.Constraint.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><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> diff --git a/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html new file mode 100644 index 0000000..eee9195 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/IntegerConstraint.html @@ -0,0 +1,293 @@ +<!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>IntegerConstraint (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="IntegerConstraint (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/IntegerConstraint.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/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/IntegerConstraint.html" target="_top">Frames</a></li> +<li><a href="IntegerConstraint.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.constraint</div> +<h2 title="Annotation Type IntegerConstraint" class="title">Annotation Type IntegerConstraint</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">@ConstraintDefinition</a> +public @interface <span class="strong">IntegerConstraint</span></pre> +<div class="block">Limits the value of a property to be a member of a specific set. The + property value may be a boxed or unboxed byte, short, int, long, float, + double, String, CharSequence, char, Character, or character array. If the + property value is outside the set, an IllegalArgumentException is thrown. + + <p>Example:<pre> + public interface UserInfo extends Storable { + int getAge(); + <b>@IntegerConstraint(min=0, max=120)</b> + void setAge(int value); + + int getRoleID(); + <b>@IntegerConstraint(allowed={ROLE_REGULAR, ROLE_ADMIN})</b> + void setRoleID(int role); + + ... + } + </pre></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/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>FloatConstraint</code></a>, +<a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>TextConstraint</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#allowed()">allowed</a></strong></code> +<div class="block">Specific allowed values for property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#disallowed()">disallowed</a></strong></code> +<div class="block">Specific disallowed values for property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#max()">max</a></strong></code> +<div class="block">Specify maximum allowed value for integer property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#min()">min</a></strong></code> +<div class="block">Specify minimum allowed value for integer property.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="allowed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allowed</h4> +<pre>public abstract long[] allowed</pre> +<div class="block">Specific allowed values for property. Default is unlimited.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="disallowed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disallowed</h4> +<pre>public abstract long[] disallowed</pre> +<div class="block">Specific disallowed values for property. Default is none.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="min()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>min</h4> +<pre>public abstract long min</pre> +<div class="block">Specify minimum allowed value for integer property. Default is unlimited.</div> +<dl> +<dt>Default:</dt> +<dd>-9223372036854775808L</dd> +</dl> +</li> +</ul> +<a name="max()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>max</h4> +<pre>public abstract long max</pre> +<div class="block">Specify maximum allowed value for integer property. Default is unlimited.</div> +<dl> +<dt>Default:</dt> +<dd>9223372036854775807L</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/IntegerConstraint.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/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/IntegerConstraint.html" target="_top">Frames</a></li> +<li><a href="IntegerConstraint.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html new file mode 100644 index 0000000..49687a5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.Constraint.html @@ -0,0 +1,404 @@ +<!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>LengthConstraint.Constraint (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="LengthConstraint.Constraint (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/LengthConstraint.Constraint.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/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="LengthConstraint.Constraint.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><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.constraint</div> +<h2 title="Class LengthConstraint.Constraint" class="title">Class LengthConstraint.Constraint</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.constraint.LengthConstraint.Constraint</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">LengthConstraint.Constraint</span> +extends java.lang.Object</pre> +<div class="block">Constraint implementation for <a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>LengthConstraint</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/constraint/LengthConstraint.Constraint.html#LengthConstraint.Constraint(java.lang.Class, java.lang.String, int, int)">LengthConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + int min, + int max)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#LengthConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.LengthConstraint)">LengthConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a> ann)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(boolean[])">constrain</a></strong>(boolean[] array)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(byte[])">constrain</a></strong>(byte[] array)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(char[])">constrain</a></strong>(char[] array)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(java.lang.CharSequence)">constrain</a></strong>(java.lang.CharSequence str)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(double[])">constrain</a></strong>(double[] array)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(float[])">constrain</a></strong>(float[] array)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(int[])">constrain</a></strong>(int[] array)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(long[])">constrain</a></strong>(long[] array)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(java.lang.Object[])">constrain</a></strong>(java.lang.Object[] array)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(short[])">constrain</a></strong>(short[] array)</code> </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> +</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="LengthConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.LengthConstraint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LengthConstraint.Constraint</h4> +<pre>public LengthConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the constrained property</dd><dd><code>propertyName</code> - name of property with constraint</dd><dd><code>ann</code> - specific annotation that binds to this constraint class</dd></dl> +</li> +</ul> +<a name="LengthConstraint.Constraint(java.lang.Class, java.lang.String, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LengthConstraint.Constraint</h4> +<pre>public LengthConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + int min, + int max)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the constrained property</dd><dd><code>propertyName</code> - name of property with constraint</dd><dd><code>min</code> - minimum allowed length</dd><dd><code>max</code> - maximum allowed length</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="constrain(java.lang.CharSequence)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(java.lang.CharSequence str)</pre> +</li> +</ul> +<a name="constrain(boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(boolean[] array)</pre> +</li> +</ul> +<a name="constrain(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(byte[] array)</pre> +</li> +</ul> +<a name="constrain(short[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(short[] array)</pre> +</li> +</ul> +<a name="constrain(char[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(char[] array)</pre> +</li> +</ul> +<a name="constrain(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(int[] array)</pre> +</li> +</ul> +<a name="constrain(long[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(long[] array)</pre> +</li> +</ul> +<a name="constrain(float[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(float[] array)</pre> +</li> +</ul> +<a name="constrain(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(double[] array)</pre> +</li> +</ul> +<a name="constrain(java.lang.Object[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(java.lang.Object[] array)</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/LengthConstraint.Constraint.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/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="LengthConstraint.Constraint.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><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> diff --git a/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html new file mode 100644 index 0000000..378a28b --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/LengthConstraint.html @@ -0,0 +1,247 @@ +<!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>LengthConstraint (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="LengthConstraint (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/LengthConstraint.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/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/LengthConstraint.html" target="_top">Frames</a></li> +<li><a href="LengthConstraint.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.constraint</div> +<h2 title="Annotation Type LengthConstraint" class="title">Annotation Type LengthConstraint</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">@ConstraintDefinition</a> +public @interface <span class="strong">LengthConstraint</span></pre> +<div class="block">Limits the value of a property to lie within a specific length range. The + property value may be a String, CharSequence, or any kind of array. If the + set property length is outside the range, an IllegalArgumentException is + thrown. + + <p>Example:<pre> + public interface UserInfo extends Storable { + String getFirstName(); + <b>@LengthConstraint(min=1, max=50)</b> + void setFirstName(String name); + + ... + } + </pre></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"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html#max()">max</a></strong></code> +<div class="block">Specify maximum allowed length for property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html#min()">min</a></strong></code> +<div class="block">Specify minimum allowed length for property.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="min()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>min</h4> +<pre>public abstract int min</pre> +<div class="block">Specify minimum allowed length for property. Default is zero.</div> +<dl> +<dt>Default:</dt> +<dd>0</dd> +</dl> +</li> +</ul> +<a name="max()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>max</h4> +<pre>public abstract int max</pre> +<div class="block">Specify maximum allowed length for property. Default is unlimited.</div> +<dl> +<dt>Default:</dt> +<dd>2147483647</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/LengthConstraint.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/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/LengthConstraint.html" target="_top">Frames</a></li> +<li><a href="LengthConstraint.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html new file mode 100644 index 0000000..3b005f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/TextConstraint.Constraint.html @@ -0,0 +1,326 @@ +<!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>TextConstraint.Constraint (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="TextConstraint.Constraint (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/TextConstraint.Constraint.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/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/TextConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="TextConstraint.Constraint.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><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.constraint</div> +<h2 title="Class TextConstraint.Constraint" class="title">Class TextConstraint.Constraint</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.constraint.TextConstraint.Constraint</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">TextConstraint.Constraint</span> +extends java.lang.Object</pre> +<div class="block">Constraint implementation for <a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>TextConstraint</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/constraint/TextConstraint.Constraint.html#TextConstraint.Constraint(java.lang.Class, java.lang.String, java.lang.String[], java.lang.String[])">TextConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + java.lang.String[] allowed, + java.lang.String[] disallowed)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#TextConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.TextConstraint)">TextConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a> ann)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#constrain(char)">constrain</a></strong>(char propertyValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#constrain(char[])">constrain</a></strong>(char[] propertyValue)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#constrain(java.lang.CharSequence)">constrain</a></strong>(java.lang.CharSequence propertyValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#constrain(java.lang.String)">constrain</a></strong>(java.lang.String propertyValue)</code> </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> +</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="TextConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.TextConstraint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TextConstraint.Constraint</h4> +<pre>public TextConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a> ann)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the constrained property</dd><dd><code>propertyName</code> - name of property with constraint</dd><dd><code>ann</code> - specific annotation that binds to this constraint class</dd></dl> +</li> +</ul> +<a name="TextConstraint.Constraint(java.lang.Class, java.lang.String, java.lang.String[], java.lang.String[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TextConstraint.Constraint</h4> +<pre>public TextConstraint.Constraint(java.lang.Class<?> type, + java.lang.String propertyName, + java.lang.String[] allowed, + java.lang.String[] disallowed)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object that contains the constrained property</dd><dd><code>propertyName</code> - name of property with constraint</dd><dd><code>allowed</code> - optional set of allowed values</dd><dd><code>disallowed</code> - optional set of disallowed values</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="constrain(java.lang.CharSequence)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(java.lang.CharSequence propertyValue)</pre> +</li> +</ul> +<a name="constrain(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(java.lang.String propertyValue)</pre> +</li> +</ul> +<a name="constrain(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(char propertyValue)</pre> +</li> +</ul> +<a name="constrain(char[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>constrain</h4> +<pre>public void constrain(char[] propertyValue)</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/TextConstraint.Constraint.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/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/TextConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="TextConstraint.Constraint.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><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> diff --git a/apidocs/com/amazon/carbonado/constraint/TextConstraint.html b/apidocs/com/amazon/carbonado/constraint/TextConstraint.html new file mode 100644 index 0000000..e163aa2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/TextConstraint.html @@ -0,0 +1,249 @@ +<!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>TextConstraint (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="TextConstraint (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/TextConstraint.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/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/TextConstraint.html" target="_top">Frames</a></li> +<li><a href="TextConstraint.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.constraint</div> +<h2 title="Annotation Type TextConstraint" class="title">Annotation Type TextConstraint</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=METHOD) +<a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">@ConstraintDefinition</a> +public @interface <span class="strong">TextConstraint</span></pre> +<div class="block">Limits the value of a property to be a member of a specific set. The + property value may be a String, CharSequence, char, Character, or character + array. If the property value is outside the set, an IllegalArgumentException + is thrown. + + <p>Example:<pre> + public interface UserInfo extends Storable { + char isActive(); + <b>@TextConstraint(allowed={"Y", "N"})</b> + void setActive(char value); + + ... + } + </pre></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/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>IntegerConstraint</code></a>, +<a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>FloatConstraint</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html#allowed()">allowed</a></strong></code> +<div class="block">Specific allowed values for property.</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/constraint/TextConstraint.html#disallowed()">disallowed</a></strong></code> +<div class="block">Specific disallowed values for property.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="allowed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allowed</h4> +<pre>public abstract java.lang.String[] allowed</pre> +<div class="block">Specific allowed values for property. Default is unlimited.</div> +<dl> +<dt>Default:</dt> +<dd>{}</dd> +</dl> +</li> +</ul> +<a name="disallowed()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>disallowed</h4> +<pre>public abstract java.lang.String[] disallowed</pre> +<div class="block">Specific disallowed values for property. Default is none.</div> +<dl> +<dt>Default:</dt> +<dd>{}</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/TextConstraint.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/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/TextConstraint.html" target="_top">Frames</a></li> +<li><a href="TextConstraint.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>Required | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html b/apidocs/com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html new file mode 100644 index 0000000..393098a --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html @@ -0,0 +1,179 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.ConstraintDefinition (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="Uses of Class com.amazon.carbonado.constraint.ConstraintDefinition (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><a href="../../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html" target="_top">Frames</a></li> +<li><a href="ConstraintDefinition.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.ConstraintDefinition" class="title">Uses of Class<br>com.amazon.carbonado.constraint.ConstraintDefinition</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">ConstraintDefinition</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.constraint">com.amazon.carbonado.constraint</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property constraints.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.constraint"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">ConstraintDefinition</a> in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a> with annotations of type <a href="../../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">ConstraintDefinition</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a></strong></code> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a></strong></code> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a></strong></code> +<div class="block">Limits the value of a property to lie within a specific length range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a></strong></code> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html" target="_top">Frames</a></li> +<li><a href="ConstraintDefinition.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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html new file mode 100644 index 0000000..e6e63ae --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.FloatConstraint.Constraint (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="Uses of Class com.amazon.carbonado.constraint.FloatConstraint.Constraint (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><a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="FloatConstraint.Constraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.FloatConstraint.Constraint" class="title">Uses of Class<br>com.amazon.carbonado.constraint.FloatConstraint.Constraint</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.constraint.FloatConstraint.Constraint</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/FloatConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="FloatConstraint.Constraint.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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.html new file mode 100644 index 0000000..8438555 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/FloatConstraint.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.FloatConstraint (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="Uses of Class com.amazon.carbonado.constraint.FloatConstraint (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><a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/FloatConstraint.html" target="_top">Frames</a></li> +<li><a href="FloatConstraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.FloatConstraint" class="title">Uses of Class<br>com.amazon.carbonado.constraint.FloatConstraint</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.constraint">com.amazon.carbonado.constraint</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property constraints.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.constraint"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a> in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a> with parameters of type <a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#FloatConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.FloatConstraint)">FloatConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/FloatConstraint.html" target="_top">Frames</a></li> +<li><a href="FloatConstraint.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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html new file mode 100644 index 0000000..e658437 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.IntegerConstraint.Constraint (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="Uses of Class com.amazon.carbonado.constraint.IntegerConstraint.Constraint (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><a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="IntegerConstraint.Constraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.IntegerConstraint.Constraint" class="title">Uses of Class<br>com.amazon.carbonado.constraint.IntegerConstraint.Constraint</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.constraint.IntegerConstraint.Constraint</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/IntegerConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="IntegerConstraint.Constraint.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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html new file mode 100644 index 0000000..4c188f6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/IntegerConstraint.html @@ -0,0 +1,187 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.IntegerConstraint (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="Uses of Class com.amazon.carbonado.constraint.IntegerConstraint (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><a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/IntegerConstraint.html" target="_top">Frames</a></li> +<li><a href="IntegerConstraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.IntegerConstraint" class="title">Uses of Class<br>com.amazon.carbonado.constraint.IntegerConstraint</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.constraint">com.amazon.carbonado.constraint</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property constraints.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.constraint"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a> in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a> with parameters of type <a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#IntegerConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.IntegerConstraint)">IntegerConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with annotations of type <a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><span class="strong">StoredLob.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/StoredLob.html#setBlockSize(int)">setBlockSize</a></strong>(int size)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><span class="strong">StoredLob.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/StoredLob.html#setLength(long)">setLength</a></strong>(long length)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/IntegerConstraint.html" target="_top">Frames</a></li> +<li><a href="IntegerConstraint.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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html new file mode 100644 index 0000000..e029dcd --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.LengthConstraint.Constraint (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="Uses of Class com.amazon.carbonado.constraint.LengthConstraint.Constraint (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><a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="LengthConstraint.Constraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.LengthConstraint.Constraint" class="title">Uses of Class<br>com.amazon.carbonado.constraint.LengthConstraint.Constraint</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.constraint.LengthConstraint.Constraint</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/LengthConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="LengthConstraint.Constraint.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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.html new file mode 100644 index 0000000..c665cc2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/LengthConstraint.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.LengthConstraint (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="Uses of Class com.amazon.carbonado.constraint.LengthConstraint (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><a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/LengthConstraint.html" target="_top">Frames</a></li> +<li><a href="LengthConstraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.LengthConstraint" class="title">Uses of Class<br>com.amazon.carbonado.constraint.LengthConstraint</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.constraint">com.amazon.carbonado.constraint</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property constraints.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.constraint"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a> in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a> with parameters of type <a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#LengthConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.LengthConstraint)">LengthConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/LengthConstraint.html" target="_top">Frames</a></li> +<li><a href="LengthConstraint.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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html new file mode 100644 index 0000000..64e7f68 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.TextConstraint.Constraint (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="Uses of Class com.amazon.carbonado.constraint.TextConstraint.Constraint (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><a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="TextConstraint.Constraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.TextConstraint.Constraint" class="title">Uses of Class<br>com.amazon.carbonado.constraint.TextConstraint.Constraint</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.constraint.TextConstraint.Constraint</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/TextConstraint.Constraint.html" target="_top">Frames</a></li> +<li><a href="TextConstraint.Constraint.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> diff --git a/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.html b/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.html new file mode 100644 index 0000000..a142339 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/class-use/TextConstraint.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.constraint.TextConstraint (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="Uses of Class com.amazon.carbonado.constraint.TextConstraint (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><a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/TextConstraint.html" target="_top">Frames</a></li> +<li><a href="TextConstraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.constraint.TextConstraint" class="title">Uses of Class<br>com.amazon.carbonado.constraint.TextConstraint</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.constraint">com.amazon.carbonado.constraint</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property constraints.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.constraint"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a> in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a> with parameters of type <a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#TextConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.TextConstraint)">TextConstraint.Constraint</a></strong>(java.lang.Class<?> type, + java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a> ann)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/constraint/class-use/TextConstraint.html" target="_top">Frames</a></li> +<li><a href="TextConstraint.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> diff --git a/apidocs/com/amazon/carbonado/constraint/package-frame.html b/apidocs/com/amazon/carbonado/constraint/package-frame.html new file mode 100644 index 0000000..c16cc70 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-frame.html @@ -0,0 +1,31 @@ +<!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.constraint (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/constraint/package-summary.html" target="classFrame">com.amazon.carbonado.constraint</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint" target="classFrame">FloatConstraint.Constraint</a></li> +<li><a href="IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint" target="classFrame">IntegerConstraint.Constraint</a></li> +<li><a href="LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint" target="classFrame">LengthConstraint.Constraint</a></li> +<li><a href="TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint" target="classFrame">TextConstraint.Constraint</a></li> +</ul> +<h2 title="Annotation Types">Annotation Types</h2> +<ul title="Annotation Types"> +<li><a href="ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint" target="classFrame">ConstraintDefinition</a></li> +<li><a href="FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint" target="classFrame">FloatConstraint</a></li> +<li><a href="IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint" target="classFrame">IntegerConstraint</a></li> +<li><a href="LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint" target="classFrame">LengthConstraint</a></li> +<li><a href="TextConstraint.html" title="annotation in com.amazon.carbonado.constraint" target="classFrame">TextConstraint</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/constraint/package-summary.html b/apidocs/com/amazon/carbonado/constraint/package-summary.html new file mode 100644 index 0000000..02a0986 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-summary.html @@ -0,0 +1,206 @@ +<!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.constraint (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.constraint (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><a href="../../../../com/amazon/carbonado/capability/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/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.constraint</h1> +<div class="docSummary"> +<div class="block">Contains annotations and implementations for supporting property constraints.</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="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/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">FloatConstraint.Constraint</a></td> +<td class="colLast"> +<div class="block">Constraint implementation for <a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>FloatConstraint</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></td> +<td class="colLast"> +<div class="block">Constraint implementation for <a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>IntegerConstraint</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></td> +<td class="colLast"> +<div class="block">Constraint implementation for <a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>LengthConstraint</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></td> +<td class="colLast"> +<div class="block">Constraint implementation for <a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>TextConstraint</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/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint">ConstraintDefinition</a></td> +<td class="colLast"> +<div class="block">Allows annotations to be defined that restrict property values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint">FloatConstraint</a></td> +<td class="colLast"> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">IntegerConstraint</a></td> +<td class="colLast"> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint">LengthConstraint</a></td> +<td class="colLast"> +<div class="block">Limits the value of a property to lie within a specific length range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint">TextConstraint</a></td> +<td class="colLast"> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.constraint Description">Package com.amazon.carbonado.constraint Description</h2> +<div class="block">Contains annotations and implementations for supporting property constraints.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><code>ConstraintDefinition</code></a></dd></dl> +</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><a href="../../../../com/amazon/carbonado/capability/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/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> diff --git a/apidocs/com/amazon/carbonado/constraint/package-tree.html b/apidocs/com/amazon/carbonado/constraint/package-tree.html new file mode 100644 index 0000000..1ec966e --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-tree.html @@ -0,0 +1,141 @@ +<!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.constraint Class Hierarchy (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.constraint Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/capability/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.constraint</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">FloatConstraint.Constraint</span></a></li> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">IntegerConstraint.Constraint</span></a></li> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">LengthConstraint.Constraint</span></a></li> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">TextConstraint.Constraint</span></a></li> +</ul> +</li> +</ul> +<h2 title="Annotation Type Hierarchy">Annotation Type Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">FloatConstraint</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">TextConstraint</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">LengthConstraint</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">ConstraintDefinition</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.constraint.<a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">IntegerConstraint</span></a> (implements java.lang.annotation.Annotation)</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/capability/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/constraint/package-use.html b/apidocs/com/amazon/carbonado/constraint/package-use.html new file mode 100644 index 0000000..1348147 --- /dev/null +++ b/apidocs/com/amazon/carbonado/constraint/package-use.html @@ -0,0 +1,197 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.constraint (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="Uses of Package com.amazon.carbonado.constraint (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.constraint" class="title">Uses of Package<br>com.amazon.carbonado.constraint</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.constraint">com.amazon.carbonado.constraint</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property constraints.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.constraint"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a> used by <a href="../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/constraint/class-use/ConstraintDefinition.html#com.amazon.carbonado.constraint">ConstraintDefinition</a> +<div class="block">Allows annotations to be defined that restrict property values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/constraint/class-use/FloatConstraint.html#com.amazon.carbonado.constraint">FloatConstraint</a> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/constraint/class-use/IntegerConstraint.html#com.amazon.carbonado.constraint">IntegerConstraint</a> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/constraint/class-use/LengthConstraint.html#com.amazon.carbonado.constraint">LengthConstraint</a> +<div class="block">Limits the value of a property to lie within a specific length range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/constraint/class-use/TextConstraint.html#com.amazon.carbonado.constraint">TextConstraint</a> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/constraint/class-use/IntegerConstraint.html#com.amazon.carbonado.spi">IntegerConstraint</a> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/constraint/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html b/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html new file mode 100644 index 0000000..401e185 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/AbstractCursor.html @@ -0,0 +1,430 @@ +<!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>AbstractCursor (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="AbstractCursor (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/AbstractCursor.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/AbstractCursor.html" target="_top">Frames</a></li> +<li><a href="AbstractCursor.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><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.cursor</div> +<h2 title="Class AbstractCursor" class="title">Class AbstractCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.AbstractCursor<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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a>, <a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a>, <a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractCursor<S></span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></pre> +<div class="block">AbstractCursor implements a small set of common Cursor methods.</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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#AbstractCursor()">AbstractCursor</a></strong>()</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> c)</code> +<div class="block">Copies all remaining next elements into the given collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> c, + int limit)</code> +<div class="block">Copies a limited amount of remaining next elements into the given + collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a></strong>()</code> +<div class="block">Copies all remaining next elements into a new modifiable list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></strong>(int limit)</code> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list.</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.Cursor"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/Cursor.html#close()">close</a>, <a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">hasNext</a>, <a href="../../../../com/amazon/carbonado/Cursor.html#next()">next</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="AbstractCursor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractCursor</h4> +<pre>protected AbstractCursor()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="copyInto(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyInto</h4> +<pre>public int copyInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> c) + 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/Cursor.html#copyInto(java.util.Collection)">Cursor</a></code></strong></div> +<div class="block">Copies all remaining next elements into the given collection. This + method is roughly equivalent to the following: + <pre> + Cursor cursor; + ... + while (cursor.hasNext()) { + c.add(cursor.next()); + } + </pre> + + <p>As a side-effect of calling this method, the cursor is closed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection)">copyInto</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount of results added</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="copyInto(java.util.Collection, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyInto</h4> +<pre>public int copyInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> c, + int limit) + 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/Cursor.html#copyInto(java.util.Collection, int)">Cursor</a></code></strong></div> +<div class="block">Copies a limited amount of remaining next elements into the given + collection. This method is roughly equivalent to the following: + <pre> + Cursor cursor; + ... + while (--limit >= 0 && cursor.hasNext()) { + c.add(cursor.next()); + } + </pre></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection, int)">copyInto</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></dd> +<dd><code>limit</code> - maximum amount of elements to copy</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount of results added</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="toList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toList</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> toList() + 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/Cursor.html#toList()">Cursor</a></code></strong></div> +<div class="block">Copies all remaining next elements into a new modifiable list. This + method is roughly equivalent to the following: + <pre> + Cursor<S> cursor; + ... + List<S> list = new ... + cursor.copyInto(list); + </pre> + + <p>As a side-effect of calling this method, the cursor is closed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#toList()">toList</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a new modifiable list</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="toList(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toList</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> toList(int limit) + 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/Cursor.html#toList(int)">Cursor</a></code></strong></div> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list. This method is roughly equivalent to the following: + <pre> + Cursor<S> cursor; + ... + List<S> list = new ... + cursor.copyInto(list, limit); + </pre></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#toList(int)">toList</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - maximum amount of elements to copy</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new modifiable list</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</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/AbstractCursor.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/AbstractCursor.html" target="_top">Frames</a></li> +<li><a href="AbstractCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html b/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html new file mode 100644 index 0000000..0b6613c --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/ArraySortBuffer.html @@ -0,0 +1,395 @@ +<!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>ArraySortBuffer (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="ArraySortBuffer (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/ArraySortBuffer.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/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/ArraySortBuffer.html" target="_top">Frames</a></li> +<li><a href="ArraySortBuffer.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><a href="#fields_inherited_from_class_java.util.AbstractList">Field</a> | </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.cursor</div> +<h2 title="Class ArraySortBuffer" class="title">Class ArraySortBuffer<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractCollection<E></li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractList<E></li> +<li> +<ul class="inheritance"> +<li>java.util.ArrayList<S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.ArraySortBuffer<S></li> +</ul> +</li> +</ul> +</li> +</ul> +</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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><S>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<S>, java.util.Collection<S>, java.util.List<S>, java.util.RandomAccess</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ArraySortBuffer<S></span> +extends java.util.ArrayList<S> +implements <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><S></pre> +<div class="block">Sort buffer implementation backed by an ArrayList.</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/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><code>SortedCursor</code></a>, +<a href="../../../../serialized-form.html#com.amazon.carbonado.cursor.ArraySortBuffer">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_java.util.AbstractList"> +<!-- --> +</a> +<h3>Fields inherited from class java.util.AbstractList</h3> +<code>modCount</code></li> +</ul> +</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/cursor/ArraySortBuffer.html#ArraySortBuffer()">ArraySortBuffer</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html#ArraySortBuffer(int)">ArraySortBuffer</a></strong>(int initialCapacity)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html#close()">close</a></strong>()</code> +<div class="block">Clear and close buffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html#prepare(java.util.Comparator)">prepare</a></strong>(java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="type parameter in ArraySortBuffer">S</a>> comparator)</code> +<div class="block">Clears buffer and assigns a comparator for sorting.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html#sort()">sort</a></strong>()</code> +<div class="block">Finish sorting buffer.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.ArrayList"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.ArrayList</h3> +<code>add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractList"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractList</h3> +<code>equals, hashCode</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractCollection</h3> +<code>containsAll, toString</code></li> +</ul> +<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>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Collection"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Collection</h3> +<code>add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.List"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.List</h3> +<code>containsAll, equals, hashCode</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="ArraySortBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ArraySortBuffer</h4> +<pre>public ArraySortBuffer()</pre> +</li> +</ul> +<a name="ArraySortBuffer(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ArraySortBuffer</h4> +<pre>public ArraySortBuffer(int initialCapacity)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="prepare(java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre>public void prepare(java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="type parameter in ArraySortBuffer">S</a>> comparator)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#prepare(java.util.Comparator)">SortBuffer</a></code></strong></div> +<div class="block">Clears buffer and assigns a comparator for sorting.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#prepare(java.util.Comparator)">prepare</a></code> in interface <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="type parameter in ArraySortBuffer">S</a>></code></dd> +</dl> +</li> +</ul> +<a name="sort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sort</h4> +<pre>public void sort()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#sort()">SortBuffer</a></code></strong></div> +<div class="block">Finish sorting buffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#sort()">sort</a></code> in interface <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="type parameter in ArraySortBuffer">S</a>></code></dd> +</dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#close()">SortBuffer</a></code></strong></div> +<div class="block">Clear and close buffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#close()">close</a></code> in interface <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="type parameter in ArraySortBuffer">S</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/ArraySortBuffer.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/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/ArraySortBuffer.html" target="_top">Frames</a></li> +<li><a href="ArraySortBuffer.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><a href="#fields_inherited_from_class_java.util.AbstractList">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/cursor/ControllerCursor.html b/apidocs/com/amazon/carbonado/cursor/ControllerCursor.html new file mode 100644 index 0000000..b91dded --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/ControllerCursor.html @@ -0,0 +1,317 @@ +<!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>ControllerCursor (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="ControllerCursor (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/ControllerCursor.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/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/ControllerCursor.html" target="_top">Frames</a></li> +<li><a href="ControllerCursor.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.cursor</div> +<h2 title="Class ControllerCursor" class="title">Class ControllerCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.ControllerCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ControllerCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps another cursor and periodically calls a <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><code>controller</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>static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#apply(com.amazon.carbonado.Cursor, com.amazon.carbonado.Query.Controller)">apply</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> source, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a ControllerCursor depending on whether a controller instance is + passed in or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="type parameter in ControllerCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="apply(com.amazon.carbonado.Cursor, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>apply</h4> +<pre>public static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> apply(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> source, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Returns a ControllerCursor depending on whether a controller instance is + passed in or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if source is null</dd></dl> +</li> +</ul> +<a name="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="type parameter in ControllerCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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> +</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/ControllerCursor.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/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/ControllerCursor.html" target="_top">Frames</a></li> +<li><a href="ControllerCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html b/apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html new file mode 100644 index 0000000..9b2169e --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/DifferenceCursor.html @@ -0,0 +1,341 @@ +<!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>DifferenceCursor (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="DifferenceCursor (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/DifferenceCursor.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/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/DifferenceCursor.html" target="_top">Frames</a></li> +<li><a href="DifferenceCursor.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><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.cursor</div> +<h2 title="Class DifferenceCursor" class="title">Class DifferenceCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.DifferenceCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DifferenceCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps two Cursors and performs an <i>asymmetric set difference</i> + operation. + + <p>Both cursors must return results in the same order. Ordering is preserved + by the difference.</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/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><code>UnionCursor</code></a>, +<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><code>IntersectionCursor</code></a>, +<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><code>SymmetricDifferenceCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/cursor/DifferenceCursor.html#DifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">DifferenceCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> order)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="DifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DifferenceCursor</h4> +<pre>public DifferenceCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> order)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - cursor to wrap</dd><dd><code>right</code> - cursor to wrap whose results are completely discarded</dd><dd><code>order</code> - describes sort ordering of wrapped cursors, which must be + a total ordering</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</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/DifferenceCursor.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/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/DifferenceCursor.html" target="_top">Frames</a></li> +<li><a href="DifferenceCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html b/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html new file mode 100644 index 0000000..c00cbc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/EmptyCursor.html @@ -0,0 +1,401 @@ +<!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>EmptyCursor (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="EmptyCursor (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/EmptyCursor.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/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/EmptyCursor.html" target="_top">Frames</a></li> +<li><a href="EmptyCursor.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.cursor</div> +<h2 title="Class EmptyCursor" class="title">Class EmptyCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.EmptyCursor<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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">EmptyCursor<S></span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></pre> +<div class="block">Special cursor implementation that is empty.</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/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor"><code>SingletonCursor</code></a></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/cursor/EmptyCursor.html#close()">close</a></strong>()</code> +<div class="block">Does nothing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#copyInto(java.util.Collection)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>> c)</code> +<div class="block">Performs no copy and always returns 0.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#copyInto(java.util.Collection, int)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>> c, + int limit)</code> +<div class="block">Performs no copy and always returns 0.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#next()">next</a></strong>()</code> +<div class="block">Always throws NoSuchElementException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Always returns 0.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#the()">the</a></strong>()</code> +<div class="block">Returns the empty cursor instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#toList()">toList</a></strong>()</code> +<div class="block">Always returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html#toList(int)">toList</a></strong>(int limit)</code> +<div class="block">Always returns an empty list.</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> +</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="the()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>the</h4> +<pre>public static <S> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> the()</pre> +<div class="block">Returns the empty cursor instance.</div> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block">Does nothing.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#close()">close</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></dd> +</dl> +</li> +</ul> +<a name="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext()</pre> +<div class="block">Always returns false.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">hasNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></dd> +</dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a> next()</pre> +<div class="block">Always throws NoSuchElementException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#next()">next</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></dd> +</dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount)</pre> +<div class="block">Always returns 0.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</dd></dl> +</li> +</ul> +<a name="copyInto(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyInto</h4> +<pre>public int copyInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>> c)</pre> +<div class="block">Performs no copy and always returns 0.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection)">copyInto</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount of results added</dd></dl> +</li> +</ul> +<a name="copyInto(java.util.Collection, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyInto</h4> +<pre>public int copyInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>> c, + int limit)</pre> +<div class="block">Performs no copy and always returns 0.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection, int)">copyInto</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></dd> +<dd><code>limit</code> - maximum amount of elements to copy</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount of results added</dd></dl> +</li> +</ul> +<a name="toList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toList</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>> toList()</pre> +<div class="block">Always returns an empty list.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#toList()">toList</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a new modifiable list</dd></dl> +</li> +</ul> +<a name="toList(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toList</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>> toList(int limit)</pre> +<div class="block">Always returns an empty list.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#toList(int)">toList</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - maximum amount of elements to copy</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new modifiable list</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/EmptyCursor.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/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/EmptyCursor.html" target="_top">Frames</a></li> +<li><a href="EmptyCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html b/apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html new file mode 100644 index 0000000..79de3f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/FetchAheadCursor.html @@ -0,0 +1,331 @@ +<!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>FetchAheadCursor (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="FetchAheadCursor (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/FetchAheadCursor.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/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/FetchAheadCursor.html" target="_top">Frames</a></li> +<li><a href="FetchAheadCursor.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><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.cursor</div> +<h2 title="Class FetchAheadCursor" class="title">Class FetchAheadCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.FetchAheadCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FetchAheadCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Cursor implementation which fetches records in advance, in order to release locks.</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"> +<!-- ======== 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/cursor/FetchAheadCursor.html#FetchAheadCursor(com.amazon.carbonado.Cursor, int)">FetchAheadCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="type parameter in FetchAheadCursor">S</a>> source, + int fetchAhead)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="type parameter in FetchAheadCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="FetchAheadCursor(com.amazon.carbonado.Cursor, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FetchAheadCursor</h4> +<pre>public FetchAheadCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="type parameter in FetchAheadCursor">S</a>> source, + int fetchAhead)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fetchAhead</code> - how much to fetch ahead from source</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="type parameter in FetchAheadCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</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/FetchAheadCursor.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/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/FetchAheadCursor.html" target="_top">Frames</a></li> +<li><a href="FetchAheadCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/FilteredCursor.html b/apidocs/com/amazon/carbonado/cursor/FilteredCursor.html new file mode 100644 index 0000000..add9572 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/FilteredCursor.html @@ -0,0 +1,436 @@ +<!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>FilteredCursor (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="FilteredCursor (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/FilteredCursor.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/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/FilteredCursor.html" target="_top">Frames</a></li> +<li><a href="FilteredCursor.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><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.cursor</div> +<h2 title="Class FilteredCursor" class="title">Class FilteredCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.FilteredCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">FilteredCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps another cursor and applies custom filtering to reduce the set of + results.</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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#FilteredCursor(com.amazon.carbonado.Cursor)">FilteredCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a>> cursor)</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>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String, java.lang.Object...)">applyFilter</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor, + java.lang.Class<S> type, + java.lang.String filter, + java.lang.Object... filterValues)</code> +<div class="block">Returns a Cursor that is filtered by the given filter expression and values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Cursor)">applyFilter</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S> filterValues, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Returns a Cursor that is filtered by the given Filter and FilterValues.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#isAllowed(S)">isAllowed</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="FilteredCursor(com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FilteredCursor</h4> +<pre>protected FilteredCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a>> cursor)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="applyFilter(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>applyFilter</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> applyFilter(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor, + java.lang.Class<S> type, + java.lang.String filter, + java.lang.Object... filterValues)</pre> +<div class="block">Returns a Cursor that is filtered by the given filter expression and values.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - cursor to wrap</dd><dd><code>type</code> - type of storable</dd><dd><code>filter</code> - filter to apply</dd><dd><code>filterValues</code> - values for filter</dd> +<dt><span class="strong">Returns:</span></dt><dd>wrapped cursor which filters results</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any values are not specified</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="applyFilter(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>applyFilter</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> applyFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S> filterValues, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</pre> +<div class="block">Returns a Cursor that is filtered by the given Filter and FilterValues. + The given Filter must be composed only of the same PropertyFilter + instances as used to construct the FilterValues. An + IllegalStateException will result otherwise.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - filter to apply</dd><dd><code>filterValues</code> - values for filter, which may be null if filter has no parameters</dd><dd><code>cursor</code> - cursor to wrap</dd> +<dt><span class="strong">Returns:</span></dt><dd>wrapped cursor which filters results</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any values are not specified</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is closed</dd></dl> +</li> +</ul> +<a name="isAllowed(java.lang.Object)"> +<!-- --> +</a><a name="isAllowed(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAllowed</h4> +<pre>protected abstract boolean isAllowed(<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>false if object should not be in results</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</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/FilteredCursor.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/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/FilteredCursor.html" target="_top">Frames</a></li> +<li><a href="FilteredCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html b/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html new file mode 100644 index 0000000..dd3c96c --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html @@ -0,0 +1,488 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>GroupedCursor (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="GroupedCursor (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/GroupedCursor.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/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/GroupedCursor.html" target="_top">Frames</a></li> +<li><a href="GroupedCursor.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><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.cursor</div> +<h2 title="Class GroupedCursor" class="title">Class GroupedCursor<S,G></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><G></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.GroupedCursor<S,G></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - source type, can be anything</dd><dd><code>G</code> - aggregate type, can be anything</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><G></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">GroupedCursor<S,G></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><G></pre> +<div class="block">Abstract cursor for aggregation and finding distinct data. The source cursor + must be ordered in some fashion by the grouping properties. The arrangement of + properties must match, but it does not matter if they are ascending or + descending.</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/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><code>SortedCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String...)">GroupedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> cursor, + java.lang.Class<<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> type, + java.lang.String... groupProperties)</code> +<div class="block">Create a GroupedCursor using properties to define the group + comparator.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.util.Comparator)">GroupedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> cursor, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> groupComparator)</code> +<div class="block">Create a GroupedCursor with an existing group comparator.</div> +</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>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#addToGroup(S)">addToGroup</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a> groupMember)</code> +<div class="block">This method is called when more entries are found for the current + group.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#beginGroup(S)">beginGroup</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a> groupLeader)</code> +<div class="block">This method is called for the first entry in a group.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#comparator()">comparator</a></strong>()</code> +<div class="block">Returns the comparator used to identify group boundaries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#finishGroup()">finishGroup</a></strong>()</code> +<div class="block">This method is called when a group is finished, and it can return an + aggregate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="GroupedCursor(com.amazon.carbonado.Cursor, java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GroupedCursor</h4> +<pre>protected GroupedCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> cursor, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> groupComparator)</pre> +<div class="block">Create a GroupedCursor with an existing group comparator. The comparator + defines the ordering of the source cursor, and it should be a partial + odering. If group comparator defines a total ordering, then all groups + have one member.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - source of elements which must be ordered properly</dd><dd><code>groupComparator</code> - comparator which defines ordering of source cursor</dd></dl> +</li> +</ul> +<a name="GroupedCursor(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GroupedCursor</h4> +<pre>protected GroupedCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> cursor, + java.lang.Class<<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> type, + java.lang.String... groupProperties)</pre> +<div class="block">Create a GroupedCursor using properties to define the group + comparator. The set of properties defines the ordering of the source + cursor, and it should be a partial ordering. If properties define a + total ordering, then all groups have one member.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - source of elements which must be ordered properly</dd><dd><code>type</code> - type of storable to create cursor for</dd><dd><code>groupProperties</code> - list of properties to group by</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any property is null or not a member + of storable type</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="comparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>comparator</h4> +<pre>public java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>> comparator()</pre> +<div class="block">Returns the comparator used to identify group boundaries.</div> +</li> +</ul> +<a name="beginGroup(java.lang.Object)"> +<!-- --> +</a><a name="beginGroup(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beginGroup</h4> +<pre>protected abstract void beginGroup(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a> groupLeader) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">This method is called for the first entry in a group. This method is not + called again until after finishGroup is called.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>groupLeader</code> - first entry in group</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="addToGroup(java.lang.Object)"> +<!-- --> +</a><a name="addToGroup(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addToGroup</h4> +<pre>protected abstract void addToGroup(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a> groupMember) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">This method is called when more entries are found for the current + group. This method is not called until after beginGroup has been + called. It may called multiple times until finishGroup is called.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>groupMember</code> - additional entry in group</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="finishGroup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finishGroup</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a> finishGroup() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">This method is called when a group is finished, and it can return an + aggregate. Simply return null if aggregate should be filtered out.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>aggregate, or null to filter it out</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</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/GroupedCursor.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/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/GroupedCursor.html" target="_top">Frames</a></li> +<li><a href="GroupedCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/IntersectionCursor.html b/apidocs/com/amazon/carbonado/cursor/IntersectionCursor.html new file mode 100644 index 0000000..69a6db5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/IntersectionCursor.html @@ -0,0 +1,341 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IntersectionCursor (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="IntersectionCursor (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/IntersectionCursor.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/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/IntersectionCursor.html" target="_top">Frames</a></li> +<li><a href="IntersectionCursor.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><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.cursor</div> +<h2 title="Class IntersectionCursor" class="title">Class IntersectionCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.IntersectionCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IntersectionCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps two Cursors and performs a <i>set intersection</i> operation. In + boolean logic, this is an <i>and</i> operation. + + <p>Both cursors must return results in the same order. Ordering is preserved + by the intersection.</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/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><code>UnionCursor</code></a>, +<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><code>DifferenceCursor</code></a>, +<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><code>SymmetricDifferenceCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/cursor/IntersectionCursor.html#IntersectionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">IntersectionCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> order)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="IntersectionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IntersectionCursor</h4> +<pre>public IntersectionCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> order)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - cursor to wrap</dd><dd><code>right</code> - cursor to wrap</dd><dd><code>order</code> - describes sort ordering of wrapped cursors, which must be + a total ordering</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</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/IntersectionCursor.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/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/IntersectionCursor.html" target="_top">Frames</a></li> +<li><a href="IntersectionCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/IteratorCursor.html b/apidocs/com/amazon/carbonado/cursor/IteratorCursor.html new file mode 100644 index 0000000..c8d0ab4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/IteratorCursor.html @@ -0,0 +1,348 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IteratorCursor (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="IteratorCursor (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/IteratorCursor.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/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/IteratorCursor.html" target="_top">Frames</a></li> +<li><a href="IteratorCursor.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><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.cursor</div> +<h2 title="Class IteratorCursor" class="title">Class IteratorCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.IteratorCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IteratorCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Adapts an Iterator into a Cursor.</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"> +<!-- ======== 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/cursor/IteratorCursor.html#IteratorCursor(java.lang.Iterable)">IteratorCursor</a></strong>(java.lang.Iterable<<a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a>> iterable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html#IteratorCursor(java.lang.Iterable, java.util.concurrent.locks.Lock)">IteratorCursor</a></strong>(java.lang.Iterable<<a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a>> iterable, + java.util.concurrent.locks.Lock lock)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html#IteratorCursor(java.util.Iterator)">IteratorCursor</a></strong>(java.util.Iterator<<a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a>> iterator)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="IteratorCursor(java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IteratorCursor</h4> +<pre>public IteratorCursor(java.lang.Iterable<<a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a>> iterable)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterable</code> - collection to iterate over, or null for empty cursor</dd></dl> +</li> +</ul> +<a name="IteratorCursor(java.lang.Iterable, java.util.concurrent.locks.Lock)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IteratorCursor</h4> +<pre>public IteratorCursor(java.lang.Iterable<<a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a>> iterable, + java.util.concurrent.locks.Lock lock)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterable</code> - collection to iterate over, or null for empty cursor</dd><dd><code>lock</code> - optional lock to hold while cursor is open</dd></dl> +</li> +</ul> +<a name="IteratorCursor(java.util.Iterator)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IteratorCursor</h4> +<pre>public IteratorCursor(java.util.Iterator<<a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a>> iterator)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - iterator to wrap, or null for empty cursor</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +</li> +</ul> +<a name="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a> next()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +</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/IteratorCursor.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/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/IteratorCursor.html" target="_top">Frames</a></li> +<li><a href="IteratorCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/LimitCursor.html b/apidocs/com/amazon/carbonado/cursor/LimitCursor.html new file mode 100644 index 0000000..7663d24 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/LimitCursor.html @@ -0,0 +1,366 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>LimitCursor (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="LimitCursor (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/LimitCursor.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/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/LimitCursor.html" target="_top">Frames</a></li> +<li><a href="LimitCursor.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><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.cursor</div> +<h2 title="Class LimitCursor" class="title">Class LimitCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.LimitCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">LimitCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps another cursor to limit the amount of elements.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor"><code>SkipCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/cursor/LimitCursor.html#LimitCursor(com.amazon.carbonado.Cursor, long)">LimitCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a>> source, + long limit)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="LimitCursor(com.amazon.carbonado.Cursor, long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LimitCursor</h4> +<pre>public LimitCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a>> source, + long limit)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - maximum amount of elements</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if source is null or limit is negative</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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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> +</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/LimitCursor.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/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/LimitCursor.html" target="_top">Frames</a></li> +<li><a href="LimitCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/MergeSortBuffer.html b/apidocs/com/amazon/carbonado/cursor/MergeSortBuffer.html new file mode 100644 index 0000000..15e325d --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/MergeSortBuffer.html @@ -0,0 +1,546 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>MergeSortBuffer (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="MergeSortBuffer (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/MergeSortBuffer.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/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/MergeSortBuffer.html" target="_top">Frames</a></li> +<li><a href="MergeSortBuffer.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><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.cursor</div> +<h2 title="Class MergeSortBuffer" class="title">Class MergeSortBuffer<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>java.util.AbstractCollection<S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.MergeSortBuffer<S></li> +</ul> +</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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><S>, java.lang.Iterable<S>, java.util.Collection<S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MergeSortBuffer<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.util.AbstractCollection<S> +implements <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><S></pre> +<div class="block">Sort buffer implemented via a merge sort algorithm. If there are too many + storables to fit in the reserved memory buffer, they are sorted and + serialized to temporary files. + + <p>The following system properties can be set to change the default + performance characteristics of the merge sort. Each property name must be + prefixed with "com.amazon.carbonado.cursor.MergeSortBuffer." + + <pre> + Property Default Notes + ------------------- ---------- ---------------------------------------------- + maxArrayCapacity 8192 Larger value greatly improves performance, but + more memory is used for each running sort. + + maxOpenFileCount 100 Larger value may reduce the amount of file + merges, but there is an increased risk of + running out of file descriptors. + + outputBufferSize 10000 Larger value may improve performance of file + writing, but not by much. + + tmpdir Merge sort files by default are placed in the + Java temp directory. Override to place them + somewhere else. + </pre></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/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><code>SortedCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/cursor/MergeSortBuffer.html#MergeSortBuffer()">MergeSortBuffer</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Query.Controller)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, com.amazon.carbonado.Query.Controller)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir, + int maxArrayCapacity)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int, com.amazon.carbonado.Query.Controller)">MergeSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir, + int maxArrayCapacity, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#add(S)">add</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#clear()">clear</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#close()">close</a></strong>()</code> +<div class="block">Clear and close buffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Iterator<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#iterator()">iterator</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#prepare(java.util.Comparator)">prepare</a></strong>(java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> comparator)</code> +<div class="block">Clears buffer and assigns a comparator for sorting.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#size()">size</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html#sort()">sort</a></strong>()</code> +<div class="block">Finish sorting buffer.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractCollection</h3> +<code>addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString</code></li> +</ul> +<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, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Collection"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Collection</h3> +<code>addAll, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, toArray, toArray</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="MergeSortBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MergeSortBuffer</h4> +<pre>public MergeSortBuffer()</pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="MergeSortBuffer(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MergeSortBuffer</h4> +<pre>public MergeSortBuffer(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="MergeSortBuffer(com.amazon.carbonado.Storage)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MergeSortBuffer</h4> +<pre>public MergeSortBuffer(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storage</code> - storage for elements; if null use first Storable to + prepare reloaded Storables</dd></dl> +</li> +</ul> +<a name="MergeSortBuffer(com.amazon.carbonado.Storage, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MergeSortBuffer</h4> +<pre>public MergeSortBuffer(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storage</code> - storage for elements; if null use first Storable to + prepare reloaded Storables</dd><dd><code>controller</code> - optional controller which can abort query operation</dd></dl> +</li> +</ul> +<a name="MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MergeSortBuffer</h4> +<pre>public MergeSortBuffer(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storage</code> - storage for elements; if null use first Storable to + prepare reloaded Storables</dd><dd><code>tempDir</code> - directory to store temp files for merging, or null for default</dd></dl> +</li> +</ul> +<a name="MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MergeSortBuffer</h4> +<pre>public MergeSortBuffer(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir, + int maxArrayCapacity)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storage</code> - storage for elements; if null use first Storable to + prepare reloaded Storables</dd><dd><code>tempDir</code> - directory to store temp files for merging, or null for default</dd><dd><code>maxArrayCapacity</code> - maximum amount of storables to keep in an array + before serializing to a file</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if storage is null</dd></dl> +</li> +</ul> +<a name="MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MergeSortBuffer</h4> +<pre>public MergeSortBuffer(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> storage, + java.lang.String tempDir, + int maxArrayCapacity, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storage</code> - storage for elements; if null use first Storable to + prepare reloaded Storables</dd><dd><code>tempDir</code> - directory to store temp files for merging, or null for default</dd><dd><code>maxArrayCapacity</code> - maximum amount of storables to keep in an array + before serializing to a file</dd><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if storage is null</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="prepare(java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre>public void prepare(java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> comparator)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#prepare(java.util.Comparator)">SortBuffer</a></code></strong></div> +<div class="block">Clears buffer and assigns a comparator for sorting.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#prepare(java.util.Comparator)">prepare</a></code> in interface <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">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="add(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="add(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public boolean add(<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> storable)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>add</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>add</code> in class <code>java.util.AbstractCollection<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">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="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in class <code>java.util.AbstractCollection<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">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="iterator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public java.util.Iterator<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a>> iterator()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>iterator</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>iterator</code> in class <code>java.util.AbstractCollection<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">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="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>clear</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>clear</code> in class <code>java.util.AbstractCollection<<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">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="sort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sort</h4> +<pre>public void sort()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#sort()">SortBuffer</a></code></strong></div> +<div class="block">Finish sorting buffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#sort()">sort</a></code> in interface <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">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="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#close()">SortBuffer</a></code></strong></div> +<div class="block">Clear and close buffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#close()">close</a></code> in interface <code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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/MergeSortBuffer.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/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/MergeSortBuffer.html" target="_top">Frames</a></li> +<li><a href="MergeSortBuffer.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/MultiTransformedCursor.html b/apidocs/com/amazon/carbonado/cursor/MultiTransformedCursor.html new file mode 100644 index 0000000..b286fc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/MultiTransformedCursor.html @@ -0,0 +1,388 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>MultiTransformedCursor (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="MultiTransformedCursor (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/MultiTransformedCursor.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/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/MultiTransformedCursor.html" target="_top">Frames</a></li> +<li><a href="MultiTransformedCursor.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><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.cursor</div> +<h2 title="Class MultiTransformedCursor" class="title">Class MultiTransformedCursor<S,T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><T></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.MultiTransformedCursor<S,T></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - source type, can be anything</dd><dd><code>T</code> - target type, can be anything</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><T></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">MultiTransformedCursor<S,T></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><T></pre> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a set of target storables. This class can be used for + implementing one-to-many joins. Use <a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor"><code>TransformedCursor</code></a> for one-to-one + joins.</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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#MultiTransformedCursor(com.amazon.carbonado.Cursor)">MultiTransformedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">S</a>> cursor)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html#transform(S)">transform</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">S</a> storable)</code> +<div class="block">This method must be implemented to transform storables.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="MultiTransformedCursor(com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MultiTransformedCursor</h4> +<pre>protected MultiTransformedCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">S</a>> cursor)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="transform(java.lang.Object)"> +<!-- --> +</a><a name="transform(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transform</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a>> transform(<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">This method must be implemented to transform storables. If the storable + cannot be transformed, either throw a FetchException or return null. If + null is returned, the storable is simply filtered out.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>transformed storables, or null to filter it out</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</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/MultiTransformedCursor.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/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/MultiTransformedCursor.html" target="_top">Frames</a></li> +<li><a href="MultiTransformedCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/SingletonCursor.html b/apidocs/com/amazon/carbonado/cursor/SingletonCursor.html new file mode 100644 index 0000000..859ba03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SingletonCursor.html @@ -0,0 +1,475 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>SingletonCursor (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="SingletonCursor (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/SingletonCursor.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/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SingletonCursor.html" target="_top">Frames</a></li> +<li><a href="SingletonCursor.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><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.cursor</div> +<h2 title="Class SingletonCursor" class="title">Class SingletonCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.SingletonCursor<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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SingletonCursor<S></span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></pre> +<div class="block">Special cursor implementation that returns only one element.</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/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/cursor/SingletonCursor.html#SingletonCursor(S)">SingletonCursor</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a> object)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html#copyInto(java.util.Collection)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>> c)</code> +<div class="block">Copies all remaining next elements into the given collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html#copyInto(java.util.Collection, int)">copyInto</a></strong>(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>> c, + int limit)</code> +<div class="block">Copies a limited amount of remaining next elements into the given + collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html#toList()">toList</a></strong>()</code> +<div class="block">Copies all remaining next elements into a new modifiable list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html#toList(int)">toList</a></strong>(int limit)</code> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list.</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> +</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="SingletonCursor(java.lang.Object)"> +<!-- --> +</a><a name="SingletonCursor(S)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SingletonCursor</h4> +<pre>public SingletonCursor(<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a> object)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>object</code> - single object to return from cursor, must not be null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if object is null</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#close()">close</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></dd> +</dl> +</li> +</ul> +<a name="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">hasNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></dd> +</dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a> next()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#next()">next</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></dd> +</dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</dd></dl> +</li> +</ul> +<a name="copyInto(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyInto</h4> +<pre>public int copyInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>> c)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection)">Cursor</a></code></strong></div> +<div class="block">Copies all remaining next elements into the given collection. This + method is roughly equivalent to the following: + <pre> + Cursor cursor; + ... + while (cursor.hasNext()) { + c.add(cursor.next()); + } + </pre> + + <p>As a side-effect of calling this method, the cursor is closed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection)">copyInto</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount of results added</dd></dl> +</li> +</ul> +<a name="copyInto(java.util.Collection, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyInto</h4> +<pre>public int copyInto(java.util.Collection<? super <a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>> c, + int limit)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection, int)">Cursor</a></code></strong></div> +<div class="block">Copies a limited amount of remaining next elements into the given + collection. This method is roughly equivalent to the following: + <pre> + Cursor cursor; + ... + while (--limit >= 0 && cursor.hasNext()) { + c.add(cursor.next()); + } + </pre></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection, int)">copyInto</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></dd> +<dd><code>limit</code> - maximum amount of elements to copy</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount of results added</dd></dl> +</li> +</ul> +<a name="toList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toList</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>> toList()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#toList()">Cursor</a></code></strong></div> +<div class="block">Copies all remaining next elements into a new modifiable list. This + method is roughly equivalent to the following: + <pre> + Cursor<S> cursor; + ... + List<S> list = new ... + cursor.copyInto(list); + </pre> + + <p>As a side-effect of calling this method, the cursor is closed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#toList()">toList</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a new modifiable list</dd></dl> +</li> +</ul> +<a name="toList(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toList</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>> toList(int limit)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#toList(int)">Cursor</a></code></strong></div> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list. This method is roughly equivalent to the following: + <pre> + Cursor<S> cursor; + ... + List<S> list = new ... + cursor.copyInto(list, limit); + </pre></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#toList(int)">toList</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>limit</code> - maximum amount of elements to copy</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new modifiable list</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/SingletonCursor.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/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SingletonCursor.html" target="_top">Frames</a></li> +<li><a href="SingletonCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/SkipCursor.html b/apidocs/com/amazon/carbonado/cursor/SkipCursor.html new file mode 100644 index 0000000..219b516 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SkipCursor.html @@ -0,0 +1,366 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>SkipCursor (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="SkipCursor (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/SkipCursor.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/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SkipCursor.html" target="_top">Frames</a></li> +<li><a href="SkipCursor.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><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.cursor</div> +<h2 title="Class SkipCursor" class="title">Class SkipCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.SkipCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SkipCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps another cursor to skip an initial amount of elements.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor"><code>LimitCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/cursor/SkipCursor.html#SkipCursor(com.amazon.carbonado.Cursor, long)">SkipCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a>> source, + long skip)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="SkipCursor(com.amazon.carbonado.Cursor, long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SkipCursor</h4> +<pre>public SkipCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a>> source, + long skip)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>skip</code> - initial amount of elements to skip</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if source is null or skip is negative</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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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> +</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/SkipCursor.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/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SkipCursor.html" target="_top">Frames</a></li> +<li><a href="SkipCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/SortBuffer.html b/apidocs/com/amazon/carbonado/cursor/SortBuffer.html new file mode 100644 index 0000000..dc2c593 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SortBuffer.html @@ -0,0 +1,274 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>SortBuffer (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="SortBuffer (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/SortBuffer.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/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SortBuffer.html" target="_top">Frames</a></li> +<li><a href="SortBuffer.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.cursor</div> +<h2 title="Interface SortBuffer" class="title">Interface SortBuffer<S></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.util.Collection<S>, java.lang.Iterable<S></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">ArraySortBuffer</a>, <a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">SortBuffer<S></span> +extends java.util.Collection<S></pre> +<div class="block">Buffers up Storable instances allowing them to be sorted. Should any method + need to throw an undeclared exception, wrap it with an + UndeclaredThrowableException.</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/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><code>SortedCursor</code></a></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/cursor/SortBuffer.html#close()">close</a></strong>()</code> +<div class="block">Clear and close buffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#prepare(java.util.Comparator)">prepare</a></strong>(java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="type parameter in SortBuffer">S</a>> comparator)</code> +<div class="block">Clears buffer and assigns a comparator for sorting.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html#sort()">sort</a></strong>()</code> +<div class="block">Finish sorting buffer.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Collection"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Collection</h3> +<code>add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray</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="prepare(java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre>void prepare(java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="type parameter in SortBuffer">S</a>> comparator)</pre> +<div class="block">Clears buffer and assigns a comparator for sorting.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if comparator is null</dd></dl> +</li> +</ul> +<a name="sort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sort</h4> +<pre>void sort() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Finish sorting buffer.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if prepare was never called</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Clear and close buffer.</div> +<dl><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> +</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/SortBuffer.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/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SortBuffer.html" target="_top">Frames</a></li> +<li><a href="SortBuffer.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> diff --git a/apidocs/com/amazon/carbonado/cursor/SortedCursor.html b/apidocs/com/amazon/carbonado/cursor/SortedCursor.html new file mode 100644 index 0000000..56ddfc2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SortedCursor.html @@ -0,0 +1,476 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>SortedCursor (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="SortedCursor (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/SortedCursor.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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SortedCursor.html" target="_top">Frames</a></li> +<li><a href="SortedCursor.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><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.cursor</div> +<h2 title="Class SortedCursor" class="title">Class SortedCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.SortedCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SortedCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps another Cursor and ensures the results are sorted. If the elements in + the source cursor are already partially sorted, a handled comparator can be + passed in which specifies the partial ordering. Elements are then processed + in smaller chunks rather than sorting the entire set. The handled comparator + can represent ascending or descending order of source elements.</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"> +<!-- ======== 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/cursor/SortedCursor.html#SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.lang.Class, java.lang.String...)">SortedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> cursor, + <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> buffer, + java.lang.Class<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> type, + java.lang.String... orderProperties)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.util.Comparator, java.util.Comparator)">SortedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> cursor, + <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> buffer, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> handled, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> finisher)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#comparator()">comparator</a></strong>()</code> +<div class="block">Returns a comparator representing the effective sort order of this cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S> java.util.Comparator<S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(java.lang.Class, java.lang.String...)">createComparator</a></strong>(java.lang.Class<S> type, + java.lang.String... orderProperties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.util.Comparator<S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(java.util.List)">createComparator</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> properties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.util.Comparator<S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(com.amazon.carbonado.info.OrderedProperty...)">createComparator</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... properties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.util.Comparator, java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SortedCursor</h4> +<pre>public SortedCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> cursor, + <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> buffer, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> handled, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> finisher)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - cursor to wrap</dd><dd><code>buffer</code> - required buffer to hold results</dd><dd><code>handled</code> - optional comparator which represents how the results are + already sorted</dd><dd><code>finisher</code> - required comparator which finishes the sort</dd></dl> +</li> +</ul> +<a name="SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.lang.Class, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SortedCursor</h4> +<pre>public SortedCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> cursor, + <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> buffer, + java.lang.Class<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> type, + java.lang.String... orderProperties)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - cursor to wrap</dd><dd><code>buffer</code> - required buffer to hold results</dd><dd><code>type</code> - type of storable to create cursor for</dd><dd><code>orderProperties</code> - list of properties to order by</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any property is null or not a member + of storable type</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="createComparator(java.lang.Class, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createComparator</h4> +<pre>public static <S> java.util.Comparator<S> createComparator(java.lang.Class<S> type, + java.lang.String... orderProperties)</pre> +<div class="block">Convenience method to create a comparator which orders storables by the + given order-by properties. The property names may be prefixed with '+' + or '-' to indicate ascending or descending order. If the prefix is + omitted, ascending order is assumed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to create comparator for</dd><dd><code>orderProperties</code> - list of properties to order by</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any property is null or not a member + of storable type</dd></dl> +</li> +</ul> +<a name="createComparator(com.amazon.carbonado.info.OrderedProperty...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createComparator</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> java.util.Comparator<S> createComparator(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... properties)</pre> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - list of properties to order by</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if no properties or if any property is null</dd></dl> +</li> +</ul> +<a name="createComparator(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createComparator</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> java.util.Comparator<S> createComparator(java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> properties)</pre> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - list of properties to order by</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if no properties or if any property is null</dd></dl> +</li> +</ul> +<a name="comparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>comparator</h4> +<pre>public java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> comparator()</pre> +<div class="block">Returns a comparator representing the effective sort order of this cursor.</div> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</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/SortedCursor.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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SortedCursor.html" target="_top">Frames</a></li> +<li><a href="SortedCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html b/apidocs/com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html new file mode 100644 index 0000000..334ad60 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html @@ -0,0 +1,364 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>SymmetricDifferenceCursor (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="SymmetricDifferenceCursor (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/SymmetricDifferenceCursor.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/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" target="_top">Frames</a></li> +<li><a href="SymmetricDifferenceCursor.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><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.cursor</div> +<h2 title="Class SymmetricDifferenceCursor" class="title">Class SymmetricDifferenceCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.SymmetricDifferenceCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SymmetricDifferenceCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps two Cursors and performs a <i>symmetric set difference</i> + operation. In boolean logic, this is an <i>exclusive or</i> operation. + + <p>Both cursors must return results in the same order. Ordering is preserved + by the difference.</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/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><code>UnionCursor</code></a>, +<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><code>IntersectionCursor</code></a>, +<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><code>DifferenceCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/cursor/SymmetricDifferenceCursor.html#SymmetricDifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">SymmetricDifferenceCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> order)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#compareNext()">compareNext</a></strong>()</code> +<div class="block">Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="SymmetricDifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SymmetricDifferenceCursor</h4> +<pre>public SymmetricDifferenceCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> order)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - cursor to wrap</dd><dd><code>right</code> - cursor to wrap</dd><dd><code>order</code> - describes sort ordering of wrapped cursors, which must be + a total ordering</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="compareNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareNext</h4> +<pre>public int compareNext() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.</div> +<dl><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="next()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</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/SymmetricDifferenceCursor.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/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" target="_top">Frames</a></li> +<li><a href="SymmetricDifferenceCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/ThrottledCursor.html b/apidocs/com/amazon/carbonado/cursor/ThrottledCursor.html new file mode 100644 index 0000000..6210a94 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/ThrottledCursor.html @@ -0,0 +1,362 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ThrottledCursor (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="ThrottledCursor (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/ThrottledCursor.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/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/ThrottledCursor.html" target="_top">Frames</a></li> +<li><a href="ThrottledCursor.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><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.cursor</div> +<h2 title="Class ThrottledCursor" class="title">Class ThrottledCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.ThrottledCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ThrottledCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps another cursor and fetches results at a reduced speed.</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"> +<!-- ======== 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/cursor/ThrottledCursor.html#ThrottledCursor(com.amazon.carbonado.Cursor, double)">ThrottledCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a>> cursor, + double throttle)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="ThrottledCursor(com.amazon.carbonado.Cursor, double)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ThrottledCursor</h4> +<pre>public ThrottledCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a>> cursor, + double throttle)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - cursor to wrap</dd><dd><code>throttle</code> - 1.0 = fetch at full speed, 0.5 = fetch at half speed, + 0.1 = fetch at one tenth speed, etc.</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</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/ThrottledCursor.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/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/ThrottledCursor.html" target="_top">Frames</a></li> +<li><a href="ThrottledCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/TransformedCursor.html b/apidocs/com/amazon/carbonado/cursor/TransformedCursor.html new file mode 100644 index 0000000..521abf4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/TransformedCursor.html @@ -0,0 +1,387 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TransformedCursor (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="TransformedCursor (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/TransformedCursor.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/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/TransformedCursor.html" target="_top">Frames</a></li> +<li><a href="TransformedCursor.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><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.cursor</div> +<h2 title="Class TransformedCursor" class="title">Class TransformedCursor<S,T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><T></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.TransformedCursor<S,T></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - source type, can be anything</dd><dd><code>T</code> - target type, can be anything</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><T></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">TransformedCursor<S,T></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><T></pre> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a target storable. This class can be used for implementing + one-to-one joins. Use <a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor"><code>MultiTransformedCursor</code></a> for one-to-many joins.</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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#TransformedCursor(com.amazon.carbonado.Cursor)">TransformedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">S</a>> cursor)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html#transform(S)">transform</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">S</a> storable)</code> +<div class="block">This method must be implemented to transform storables.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="TransformedCursor(com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransformedCursor</h4> +<pre>protected TransformedCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">S</a>> cursor)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="transform(java.lang.Object)"> +<!-- --> +</a><a name="transform(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transform</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a> transform(<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">This method must be implemented to transform storables. If the storable + cannot be transformed, either throw a FetchException or return null. If + null is returned, the storable is simply filtered out.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>transformed storable, or null to filter it out</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</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/TransformedCursor.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/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/TransformedCursor.html" target="_top">Frames</a></li> +<li><a href="TransformedCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/UnionCursor.html b/apidocs/com/amazon/carbonado/cursor/UnionCursor.html new file mode 100644 index 0000000..165ef60 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/UnionCursor.html @@ -0,0 +1,341 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>UnionCursor (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="UnionCursor (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/UnionCursor.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/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/UnionCursor.html" target="_top">Frames</a></li> +<li><a href="UnionCursor.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><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.cursor</div> +<h2 title="Class UnionCursor" class="title">Class UnionCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.cursor.UnionCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnionCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Wraps two Cursors and performs a <i>set union</i> operation. In boolean + logic, this is an <i>or</i> operation. + + <p>Both cursors must return results in the same order. Ordering is preserved + by the union.</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/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><code>IntersectionCursor</code></a>, +<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><code>DifferenceCursor</code></a>, +<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><code>SymmetricDifferenceCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/cursor/UnionCursor.html#UnionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">UnionCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> order)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</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="UnionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UnionCursor</h4> +<pre>public UnionCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> left, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> right, + java.util.Comparator<<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> order)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - cursor to wrap</dd><dd><code>right</code> - cursor to wrap</dd><dd><code>order</code> - describes sort ordering of wrapped cursors, which must be + a total ordering</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a> next() + 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/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</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/UnionCursor.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/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/UnionCursor.html" target="_top">Frames</a></li> +<li><a href="UnionCursor.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><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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html new file mode 100644 index 0000000..060c4ed --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/AbstractCursor.html @@ -0,0 +1,278 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.AbstractCursor (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="Uses of Class com.amazon.carbonado.cursor.AbstractCursor (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><a href="../../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/AbstractCursor.html" target="_top">Frames</a></li> +<li><a href="AbstractCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.AbstractCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.AbstractCursor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a> in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a> in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a><S></strong></code> +<div class="block">Wraps another cursor and periodically calls a <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><code>controller</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a><S></strong></code> +<div class="block">Wraps two Cursors and performs an <i>asymmetric set difference</i> + operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a><S></strong></code> +<div class="block">Cursor implementation which fetches records in advance, in order to release locks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a><S></strong></code> +<div class="block">Wraps another cursor and applies custom filtering to reduce the set of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a><S,G></strong></code> +<div class="block">Abstract cursor for aggregation and finding distinct data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a><S></strong></code> +<div class="block">Wraps two Cursors and performs a <i>set intersection</i> operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a><S></strong></code> +<div class="block">Adapts an Iterator into a Cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a><S></strong></code> +<div class="block">Wraps another cursor to limit the amount of elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a><S,T></strong></code> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a set of target storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a><S></strong></code> +<div class="block">Wraps another cursor to skip an initial amount of elements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a><S></strong></code> +<div class="block">Wraps another Cursor and ensures the results are sorted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a><S></strong></code> +<div class="block">Wraps two Cursors and performs a <i>symmetric set difference</i> + operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a><S></strong></code> +<div class="block">Wraps another cursor and fetches results at a reduced speed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a><S,T></strong></code> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a target storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a><S></strong></code> +<div class="block">Wraps two Cursors and performs a <i>set union</i> operation.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a><S></strong></code> +<div class="block">Abstract Cursor implementation for a repository that manipulates raw bytes.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/AbstractCursor.html" target="_top">Frames</a></li> +<li><a href="AbstractCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/ArraySortBuffer.html b/apidocs/com/amazon/carbonado/cursor/class-use/ArraySortBuffer.html new file mode 100644 index 0000000..3f06cc4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/ArraySortBuffer.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.ArraySortBuffer (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="Uses of Class com.amazon.carbonado.cursor.ArraySortBuffer (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><a href="../../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/ArraySortBuffer.html" target="_top">Frames</a></li> +<li><a href="ArraySortBuffer.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.ArraySortBuffer" class="title">Uses of Class<br>com.amazon.carbonado.cursor.ArraySortBuffer</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.ArraySortBuffer</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/ArraySortBuffer.html" target="_top">Frames</a></li> +<li><a href="ArraySortBuffer.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/ControllerCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/ControllerCursor.html new file mode 100644 index 0000000..4a50a3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/ControllerCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.ControllerCursor (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="Uses of Class com.amazon.carbonado.cursor.ControllerCursor (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><a href="../../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/ControllerCursor.html" target="_top">Frames</a></li> +<li><a href="ControllerCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.ControllerCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.ControllerCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.ControllerCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/ControllerCursor.html" target="_top">Frames</a></li> +<li><a href="ControllerCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/DifferenceCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/DifferenceCursor.html new file mode 100644 index 0000000..ca08d68 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/DifferenceCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.DifferenceCursor (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="Uses of Class com.amazon.carbonado.cursor.DifferenceCursor (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><a href="../../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/DifferenceCursor.html" target="_top">Frames</a></li> +<li><a href="DifferenceCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.DifferenceCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.DifferenceCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.DifferenceCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/DifferenceCursor.html" target="_top">Frames</a></li> +<li><a href="DifferenceCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/EmptyCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/EmptyCursor.html new file mode 100644 index 0000000..ba4705f --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/EmptyCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.EmptyCursor (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="Uses of Class com.amazon.carbonado.cursor.EmptyCursor (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><a href="../../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/EmptyCursor.html" target="_top">Frames</a></li> +<li><a href="EmptyCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.EmptyCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.EmptyCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.EmptyCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/EmptyCursor.html" target="_top">Frames</a></li> +<li><a href="EmptyCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/FetchAheadCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/FetchAheadCursor.html new file mode 100644 index 0000000..612f0de --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/FetchAheadCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.FetchAheadCursor (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="Uses of Class com.amazon.carbonado.cursor.FetchAheadCursor (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><a href="../../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/FetchAheadCursor.html" target="_top">Frames</a></li> +<li><a href="FetchAheadCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.FetchAheadCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.FetchAheadCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.FetchAheadCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/FetchAheadCursor.html" target="_top">Frames</a></li> +<li><a href="FetchAheadCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/FilteredCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/FilteredCursor.html new file mode 100644 index 0000000..5762116 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/FilteredCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.FilteredCursor (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="Uses of Class com.amazon.carbonado.cursor.FilteredCursor (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><a href="../../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/FilteredCursor.html" target="_top">Frames</a></li> +<li><a href="FilteredCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.FilteredCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.FilteredCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.FilteredCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/FilteredCursor.html" target="_top">Frames</a></li> +<li><a href="FilteredCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/GroupedCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/GroupedCursor.html new file mode 100644 index 0000000..021f04a --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/GroupedCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.GroupedCursor (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="Uses of Class com.amazon.carbonado.cursor.GroupedCursor (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><a href="../../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/GroupedCursor.html" target="_top">Frames</a></li> +<li><a href="GroupedCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.GroupedCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.GroupedCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.GroupedCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/GroupedCursor.html" target="_top">Frames</a></li> +<li><a href="GroupedCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/IntersectionCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/IntersectionCursor.html new file mode 100644 index 0000000..944e59a --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/IntersectionCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.IntersectionCursor (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="Uses of Class com.amazon.carbonado.cursor.IntersectionCursor (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><a href="../../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/IntersectionCursor.html" target="_top">Frames</a></li> +<li><a href="IntersectionCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.IntersectionCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.IntersectionCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.IntersectionCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/IntersectionCursor.html" target="_top">Frames</a></li> +<li><a href="IntersectionCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/IteratorCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/IteratorCursor.html new file mode 100644 index 0000000..5c6cd52 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/IteratorCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.IteratorCursor (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="Uses of Class com.amazon.carbonado.cursor.IteratorCursor (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><a href="../../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/IteratorCursor.html" target="_top">Frames</a></li> +<li><a href="IteratorCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.IteratorCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.IteratorCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.IteratorCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/IteratorCursor.html" target="_top">Frames</a></li> +<li><a href="IteratorCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/LimitCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/LimitCursor.html new file mode 100644 index 0000000..2715595 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/LimitCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.LimitCursor (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="Uses of Class com.amazon.carbonado.cursor.LimitCursor (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><a href="../../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/LimitCursor.html" target="_top">Frames</a></li> +<li><a href="LimitCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.LimitCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.LimitCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.LimitCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/LimitCursor.html" target="_top">Frames</a></li> +<li><a href="LimitCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/MergeSortBuffer.html b/apidocs/com/amazon/carbonado/cursor/class-use/MergeSortBuffer.html new file mode 100644 index 0000000..3f2b153 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/MergeSortBuffer.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.MergeSortBuffer (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="Uses of Class com.amazon.carbonado.cursor.MergeSortBuffer (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><a href="../../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/MergeSortBuffer.html" target="_top">Frames</a></li> +<li><a href="MergeSortBuffer.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.MergeSortBuffer" class="title">Uses of Class<br>com.amazon.carbonado.cursor.MergeSortBuffer</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.MergeSortBuffer</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/MergeSortBuffer.html" target="_top">Frames</a></li> +<li><a href="MergeSortBuffer.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/MultiTransformedCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/MultiTransformedCursor.html new file mode 100644 index 0000000..512f70d --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/MultiTransformedCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.MultiTransformedCursor (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="Uses of Class com.amazon.carbonado.cursor.MultiTransformedCursor (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><a href="../../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/MultiTransformedCursor.html" target="_top">Frames</a></li> +<li><a href="MultiTransformedCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.MultiTransformedCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.MultiTransformedCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.MultiTransformedCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/MultiTransformedCursor.html" target="_top">Frames</a></li> +<li><a href="MultiTransformedCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/SingletonCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/SingletonCursor.html new file mode 100644 index 0000000..9eeb19e --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/SingletonCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.SingletonCursor (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="Uses of Class com.amazon.carbonado.cursor.SingletonCursor (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><a href="../../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SingletonCursor.html" target="_top">Frames</a></li> +<li><a href="SingletonCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.SingletonCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.SingletonCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.SingletonCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SingletonCursor.html" target="_top">Frames</a></li> +<li><a href="SingletonCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/SkipCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/SkipCursor.html new file mode 100644 index 0000000..54ea253 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/SkipCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.SkipCursor (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="Uses of Class com.amazon.carbonado.cursor.SkipCursor (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><a href="../../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SkipCursor.html" target="_top">Frames</a></li> +<li><a href="SkipCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.SkipCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.SkipCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.SkipCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SkipCursor.html" target="_top">Frames</a></li> +<li><a href="SkipCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/SortBuffer.html b/apidocs/com/amazon/carbonado/cursor/class-use/SortBuffer.html new file mode 100644 index 0000000..4742701 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/SortBuffer.html @@ -0,0 +1,244 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.cursor.SortBuffer (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="Uses of Interface com.amazon.carbonado.cursor.SortBuffer (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><a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SortBuffer.html" target="_top">Frames</a></li> +<li><a href="SortBuffer.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"> +<h2 title="Uses of Interface com.amazon.carbonado.cursor.SortBuffer" class="title">Uses of Interface<br>com.amazon.carbonado.cursor.SortBuffer</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a> in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> that implement <a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">ArraySortBuffer</a><S></strong></code> +<div class="block">Sort buffer implementation backed by an ArrayList.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Sort buffer implemented via a merge sort algorithm.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html#SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.lang.Class, java.lang.String...)">SortedCursor</a></strong>(<a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> cursor, + <a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> buffer, + java.lang.Class<<a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> type, + java.lang.String... orderProperties)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html#SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.util.Comparator, java.util.Comparator)">SortedCursor</a></strong>(<a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> cursor, + <a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> buffer, + java.util.Comparator<<a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> handled, + java.util.Comparator<<a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> finisher)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.ArraySortSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Returns a new ArraySortBuffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.MergeSortSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Returns a new MergeSortBuffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.ArraySortSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new ArraySortBuffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.MergeSortSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new MergeSortBuffer.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SortBuffer.html" target="_top">Frames</a></li> +<li><a href="SortBuffer.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/SortedCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/SortedCursor.html new file mode 100644 index 0000000..26dcba7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/SortedCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.SortedCursor (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="Uses of Class com.amazon.carbonado.cursor.SortedCursor (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><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SortedCursor.html" target="_top">Frames</a></li> +<li><a href="SortedCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.SortedCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.SortedCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.SortedCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SortedCursor.html" target="_top">Frames</a></li> +<li><a href="SortedCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/SymmetricDifferenceCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/SymmetricDifferenceCursor.html new file mode 100644 index 0000000..075a430 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/SymmetricDifferenceCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.SymmetricDifferenceCursor (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="Uses of Class com.amazon.carbonado.cursor.SymmetricDifferenceCursor (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><a href="../../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SymmetricDifferenceCursor.html" target="_top">Frames</a></li> +<li><a href="SymmetricDifferenceCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.SymmetricDifferenceCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.SymmetricDifferenceCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.SymmetricDifferenceCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/SymmetricDifferenceCursor.html" target="_top">Frames</a></li> +<li><a href="SymmetricDifferenceCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/ThrottledCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/ThrottledCursor.html new file mode 100644 index 0000000..3604232 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/ThrottledCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.ThrottledCursor (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="Uses of Class com.amazon.carbonado.cursor.ThrottledCursor (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><a href="../../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/ThrottledCursor.html" target="_top">Frames</a></li> +<li><a href="ThrottledCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.ThrottledCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.ThrottledCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.ThrottledCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/ThrottledCursor.html" target="_top">Frames</a></li> +<li><a href="ThrottledCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/TransformedCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/TransformedCursor.html new file mode 100644 index 0000000..4adf2d1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/TransformedCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.TransformedCursor (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="Uses of Class com.amazon.carbonado.cursor.TransformedCursor (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><a href="../../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/TransformedCursor.html" target="_top">Frames</a></li> +<li><a href="TransformedCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.TransformedCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.TransformedCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.TransformedCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/TransformedCursor.html" target="_top">Frames</a></li> +<li><a href="TransformedCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/class-use/UnionCursor.html b/apidocs/com/amazon/carbonado/cursor/class-use/UnionCursor.html new file mode 100644 index 0000000..8b22701 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/class-use/UnionCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.cursor.UnionCursor (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="Uses of Class com.amazon.carbonado.cursor.UnionCursor (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><a href="../../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/UnionCursor.html" target="_top">Frames</a></li> +<li><a href="UnionCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.cursor.UnionCursor" class="title">Uses of Class<br>com.amazon.carbonado.cursor.UnionCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.cursor.UnionCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/cursor/class-use/UnionCursor.html" target="_top">Frames</a></li> +<li><a href="UnionCursor.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> diff --git a/apidocs/com/amazon/carbonado/cursor/package-frame.html b/apidocs/com/amazon/carbonado/cursor/package-frame.html new file mode 100644 index 0000000..52a0fe8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/package-frame.html @@ -0,0 +1,43 @@ +<!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.cursor (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/cursor/package-summary.html" target="classFrame">com.amazon.carbonado.cursor</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="SortBuffer.html" title="interface in com.amazon.carbonado.cursor" target="classFrame"><i>SortBuffer</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">AbstractCursor</a></li> +<li><a href="ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor" target="classFrame">ArraySortBuffer</a></li> +<li><a href="ControllerCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">ControllerCursor</a></li> +<li><a href="DifferenceCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">DifferenceCursor</a></li> +<li><a href="EmptyCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">EmptyCursor</a></li> +<li><a href="FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">FetchAheadCursor</a></li> +<li><a href="FilteredCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">FilteredCursor</a></li> +<li><a href="GroupedCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">GroupedCursor</a></li> +<li><a href="IntersectionCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">IntersectionCursor</a></li> +<li><a href="IteratorCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">IteratorCursor</a></li> +<li><a href="LimitCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">LimitCursor</a></li> +<li><a href="MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor" target="classFrame">MergeSortBuffer</a></li> +<li><a href="MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">MultiTransformedCursor</a></li> +<li><a href="SingletonCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">SingletonCursor</a></li> +<li><a href="SkipCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">SkipCursor</a></li> +<li><a href="SortedCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">SortedCursor</a></li> +<li><a href="SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">SymmetricDifferenceCursor</a></li> +<li><a href="ThrottledCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">ThrottledCursor</a></li> +<li><a href="TransformedCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">TransformedCursor</a></li> +<li><a href="UnionCursor.html" title="class in com.amazon.carbonado.cursor" target="classFrame">UnionCursor</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/cursor/package-summary.html b/apidocs/com/amazon/carbonado/cursor/package-summary.html new file mode 100644 index 0000000..e72c8d3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/package-summary.html @@ -0,0 +1,284 @@ +<!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.cursor (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.cursor (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><a href="../../../../com/amazon/carbonado/constraint/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/filter/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/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.cursor</h1> +<div class="docSummary"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</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/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><S></td> +<td class="colLast"> +<div class="block">Buffers up Storable instances allowing them to be sorted.</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/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></td> +<td class="colLast"> +<div class="block">AbstractCursor implements a small set of common Cursor methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">ArraySortBuffer</a><S></td> +<td class="colLast"> +<div class="block">Sort buffer implementation backed by an ArrayList.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps another cursor and periodically calls a <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><code>controller</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps two Cursors and performs an <i>asymmetric set difference</i> + operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a><S></td> +<td class="colLast"> +<div class="block">Special cursor implementation that is empty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a><S></td> +<td class="colLast"> +<div class="block">Cursor implementation which fetches records in advance, in order to release locks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps another cursor and applies custom filtering to reduce the set of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a><S,G></td> +<td class="colLast"> +<div class="block">Abstract cursor for aggregation and finding distinct data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps two Cursors and performs a <i>set intersection</i> operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a><S></td> +<td class="colLast"> +<div class="block">Adapts an Iterator into a Cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps another cursor to limit the amount of elements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</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">Sort buffer implemented via a merge sort algorithm.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a><S,T></td> +<td class="colLast"> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a set of target storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a><S></td> +<td class="colLast"> +<div class="block">Special cursor implementation that returns only one element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps another cursor to skip an initial amount of elements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps another Cursor and ensures the results are sorted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps two Cursors and performs a <i>symmetric set difference</i> + operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps another cursor and fetches results at a reduced speed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a><S,T></td> +<td class="colLast"> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a target storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a><S></td> +<td class="colLast"> +<div class="block">Wraps two Cursors and performs a <i>set union</i> operation.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.cursor Description">Package com.amazon.carbonado.cursor Description</h2> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</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><a href="../../../../com/amazon/carbonado/constraint/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/filter/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/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> diff --git a/apidocs/com/amazon/carbonado/cursor/package-tree.html b/apidocs/com/amazon/carbonado/cursor/package-tree.html new file mode 100644 index 0000000..46b2f56 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/package-tree.html @@ -0,0 +1,176 @@ +<!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.cursor Class Hierarchy (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.cursor Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/constraint/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/filter/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.cursor</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.util.AbstractCollection<E> (implements java.util.Collection<E>) +<ul> +<li type="circle">java.util.AbstractList<E> (implements java.util.List<E>) +<ul> +<li type="circle">java.util.ArrayList<E> (implements java.lang.Cloneable, java.util.List<E>, java.util.RandomAccess, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">ArraySortBuffer</span></a><S> (implements com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><S>)</li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">MergeSortBuffer</span></a><S> (implements com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">AbstractCursor</span></a><S> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S>) +<ul> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">ControllerCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">DifferenceCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">FetchAheadCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">FilteredCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">GroupedCursor</span></a><S,G></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">IntersectionCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">IteratorCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">LimitCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">MultiTransformedCursor</span></a><S,T></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">SkipCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">SortedCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">SymmetricDifferenceCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">ThrottledCursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">TransformedCursor</span></a><S,T></li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">UnionCursor</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">EmptyCursor</span></a><S> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S>)</li> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">SingletonCursor</span></a><S> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">java.lang.Iterable<T> +<ul> +<li type="circle">java.util.Collection<E> +<ul> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor"><span class="strong">SortBuffer</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/constraint/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/filter/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/cursor/package-use.html b/apidocs/com/amazon/carbonado/cursor/package-use.html new file mode 100644 index 0000000..1625ce6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/cursor/package-use.html @@ -0,0 +1,207 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.cursor (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="Uses of Package com.amazon.carbonado.cursor (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.cursor" class="title">Uses of Package<br>com.amazon.carbonado.cursor</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> used by <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/cursor/class-use/AbstractCursor.html#com.amazon.carbonado.cursor">AbstractCursor</a> +<div class="block">AbstractCursor implements a small set of common Cursor methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/cursor/class-use/SortBuffer.html#com.amazon.carbonado.cursor">SortBuffer</a> +<div class="block">Buffers up Storable instances allowing them to be sorted.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> used by <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/cursor/class-use/SortBuffer.html#com.amazon.carbonado.qe">SortBuffer</a> +<div class="block">Buffers up Storable instances allowing them to be sorted.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/cursor/class-use/AbstractCursor.html#com.amazon.carbonado.raw">AbstractCursor</a> +<div class="block">AbstractCursor implements a small set of common Cursor methods.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/cursor/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/filter/AndFilter.html b/apidocs/com/amazon/carbonado/filter/AndFilter.html new file mode 100644 index 0000000..00e4c87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/AndFilter.html @@ -0,0 +1,392 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AndFilter (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="AndFilter (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/AndFilter.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/AndFilter.html" target="_top">Frames</a></li> +<li><a href="AndFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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.filter</div> +<h2 title="Class AndFilter" class="title">Class AndFilter<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><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.Filter</a><S></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.BinaryOpFilter</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.AndFilter<S></li> +</ul> +</li> +</ul> +</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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">AndFilter<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a><S></pre> +<div class="block">Filter tree node that performs a logical 'and' test.</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="../../../../serialized-form.html#com.amazon.carbonado.filter.AndFilter">Serialized Form</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></li> +</ul> +</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><R,P> R</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/AndFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>,R,P> visitor, + P param)</code> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/AndFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>> values)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/AndFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/AndFilter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/AndFilter.html#not()">not</a></strong>()</code> +<div class="block">Returns the logical negation of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/AndFilter.html#unbind()">unbind</a></strong>()</code> +<div class="block">Undoes the effect of a bind operation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.BinaryOpFilter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#bind()">bind</a>, <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#getLeftFilter()">getLeftFilter</a>, <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#getRightFilter()">getRightFilter</a>, <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#isBound()">isBound</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>> not()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">Filter</a></code></strong></div> +<div class="block">Returns the logical negation of this filter.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="accept(com.amazon.carbonado.filter.Visitor,java.lang.Object)"> +<!-- --> +</a><a name="accept(com.amazon.carbonado.filter.Visitor, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <R,P> R accept(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>,R,P> visitor, + P param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">Filter</a></code></strong></div> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">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>visitor</code> - visitor to traverse through the tree</dd><dd><code>param</code> - generic input parameter passed to visit methods</dd> +<dt><span class="strong">Returns:</span></dt><dd>generic return value passed from visit methods</dd></dl> +</li> +</ul> +<a name="unbind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unbind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>> unbind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">Filter</a></code></strong></div> +<div class="block">Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with unbound property filters</dd></dl> +</li> +</ul> +<a name="asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFromAny</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> asJoinedFromAny(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">Filter</a></code></strong></div> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">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="appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">Filter</a></code></strong></div> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optionally supply filter values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/AndFilter.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/AndFilter.html" target="_top">Frames</a></li> +<li><a href="AndFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/filter/BinaryOpFilter.html b/apidocs/com/amazon/carbonado/filter/BinaryOpFilter.html new file mode 100644 index 0000000..d5eb470 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/BinaryOpFilter.html @@ -0,0 +1,322 @@ +<!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:40 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>BinaryOpFilter (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="BinaryOpFilter (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/BinaryOpFilter.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/filter/AndFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/BinaryOpFilter.html" target="_top">Frames</a></li> +<li><a href="BinaryOpFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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.filter</div> +<h2 title="Class BinaryOpFilter" class="title">Class BinaryOpFilter<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><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.Filter</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.BinaryOpFilter<S></li> +</ul> +</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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a>, <a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">BinaryOpFilter<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S></pre> +<div class="block">Base class for filter tree nodes that have a left and right child.</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="../../../../serialized-form.html#com.amazon.carbonado.filter.BinaryOpFilter">Serialized Form</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></li> +</ul> +</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/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#bind()">bind</a></strong>()</code> +<div class="block">Walks through each property filter, assigning a bind ID to it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#getLeftFilter()">getLeftFilter</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#getRightFilter()">getRightFilter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#isBound()">isBound</a></strong>()</code> +<div class="block">Returns true if all property filters are known to be properly + bound.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="getLeftFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLeftFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>> getLeftFilter()</pre> +</li> +</ul> +<a name="getRightFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRightFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>> getRightFilter()</pre> +</li> +</ul> +<a name="bind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>> bind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">Filter</a></code></strong></div> +<div class="block">Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">bind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with bound property filters</dd></dl> +</li> +</ul> +<a name="isBound()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isBound</h4> +<pre>public boolean isBound()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">Filter</a></code></strong></div> +<div class="block">Returns true if all property filters are known to be properly + bound. This is a side effect of calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>Filter.bind()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()"><code>Filter.initialFilterValues()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()"><code>Filter.disjunctiveNormalForm()</code></a> or <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()"><code>Filter.conjunctiveNormalForm()</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">isBound</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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/BinaryOpFilter.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/filter/AndFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/BinaryOpFilter.html" target="_top">Frames</a></li> +<li><a href="BinaryOpFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/filter/ClosedFilter.html b/apidocs/com/amazon/carbonado/filter/ClosedFilter.html new file mode 100644 index 0000000..dca312a --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/ClosedFilter.html @@ -0,0 +1,589 @@ +<!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>ClosedFilter (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="ClosedFilter (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/ClosedFilter.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/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/ClosedFilter.html" target="_top">Frames</a></li> +<li><a href="ClosedFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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.filter</div> +<h2 title="Class ClosedFilter" class="title">Class ClosedFilter<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><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.Filter</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.ClosedFilter<S></li> +</ul> +</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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ClosedFilter<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S></pre> +<div class="block">Filter which blocks any results from passing through.</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="../../../../serialized-form.html#com.amazon.carbonado.filter.ClosedFilter">Serialized Form</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></li> +</ul> +</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><R,P> R</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>,R,P> visitor, + P param)</code> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> values)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#bind()">bind</a></strong>()</code> +<div class="block">Walks through each property filter, assigning a bind ID to it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its conjunctive normal form.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its disjunctive normal form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#initialFilterValues()">initialFilterValues</a></strong>()</code> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#isBound()">isBound</a></strong>()</code> +<div class="block">Returns true if all property filters are known to be properly + bound.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#isClosed()">isClosed</a></strong>()</code> +<div class="block">Always returns true.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#not()">not</a></strong>()</code> +<div class="block">Returns the logical negation of this filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</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/filter/ClosedFilter.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the string value of this filter, which is also parsable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html#unbind()">unbind</a></strong>()</code> +<div class="block">Undoes the effect of a bind operation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="isClosed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public final boolean isClosed()</pre> +<div class="block">Always returns true.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">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="and(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> and(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> filter)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">Filter</a></code></strong></div> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="or(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> or(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> filter)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">Filter</a></code></strong></div> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> not()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">Filter</a></code></strong></div> +<div class="block">Returns the logical negation of this filter.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="disjunctiveNormalFormSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disjunctiveNormalFormSplit</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>>> disjunctiveNormalFormSplit()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">Filter</a></code></strong></div> +<div class="block">Splits the filter from its disjunctive normal form. Or'ng the filters + together produces the full disjunctive normal form.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of sub filters which don't perform any 'or' + operations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.1</dd></dl> +</li> +</ul> +<a name="conjunctiveNormalFormSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conjunctiveNormalFormSplit</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>>> conjunctiveNormalFormSplit()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">Filter</a></code></strong></div> +<div class="block">Splits the filter from its conjunctive normal form. And'ng the filters + together produces the full conjunctive normal form.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of sub filters which don't perform any 'and' + operations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.1</dd></dl> +</li> +</ul> +<a name="initialFilterValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialFilterValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> initialFilterValues()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">Filter</a></code></strong></div> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter. Returns null if Filter has no parameters. + + <p>Note: The returned FilterValues instance may reference a different + filter instance than this one. Call getFilter to retrieve it. The + difference is caused by the filter property values being <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>bound</code></a>.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">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="accept(com.amazon.carbonado.filter.Visitor,java.lang.Object)"> +<!-- --> +</a><a name="accept(com.amazon.carbonado.filter.Visitor, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <R,P> R accept(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>,R,P> visitor, + P param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">Filter</a></code></strong></div> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">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>visitor</code> - visitor to traverse through the tree</dd><dd><code>param</code> - generic input parameter passed to visit methods</dd> +<dt><span class="strong">Returns:</span></dt><dd>generic return value passed from visit methods</dd></dl> +</li> +</ul> +<a name="bind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> bind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">Filter</a></code></strong></div> +<div class="block">Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">bind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with bound property filters</dd></dl> +</li> +</ul> +<a name="unbind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unbind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> unbind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">Filter</a></code></strong></div> +<div class="block">Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with unbound property filters</dd></dl> +</li> +</ul> +<a name="isBound()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBound</h4> +<pre>public boolean isBound()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">Filter</a></code></strong></div> +<div class="block">Returns true if all property filters are known to be properly + bound. This is a side effect of calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>Filter.bind()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()"><code>Filter.initialFilterValues()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()"><code>Filter.disjunctiveNormalForm()</code></a> or <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()"><code>Filter.conjunctiveNormalForm()</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">isBound</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">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="asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFromAny</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><T> asJoinedFromAny(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">Filter</a></code></strong></div> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">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="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">Filter</a></code></strong></div> +<div class="block">Returns the string value of this filter, which is also parsable.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">toString</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">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="appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">Filter</a></code></strong></div> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optionally supply filter values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/ClosedFilter.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/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/ClosedFilter.html" target="_top">Frames</a></li> +<li><a href="ClosedFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/filter/ExistsFilter.html b/apidocs/com/amazon/carbonado/filter/ExistsFilter.html new file mode 100644 index 0000000..56340e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/ExistsFilter.html @@ -0,0 +1,509 @@ +<!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>ExistsFilter (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="ExistsFilter (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/ExistsFilter.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/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/ExistsFilter.html" target="_top">Frames</a></li> +<li><a href="ExistsFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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.filter</div> +<h2 title="Class ExistsFilter" class="title">Class ExistsFilter<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><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.Filter</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.ExistsFilter<S></li> +</ul> +</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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ExistsFilter<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S></pre> +<div class="block">Filter tree node that performs an existence or non-existence test against a + join property.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.amazon.carbonado.filter.ExistsFilter">Serialized Form</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></li> +</ul> +</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><R,P> R</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>,R,P> visitor, + P param)</code> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>> values)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#bind()">bind</a></strong>()</code> +<div class="block">Walks through each property filter, assigning a bind ID to it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#getChainedProperty()">getChainedProperty</a></strong>()</code> +<div class="block">Returns the join property that is being checked for existence or + non-existence.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#getSubFilter()">getSubFilter</a></strong>()</code> +<div class="block">Returns the filter applied to the join, which might be open.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#initialFilterValues()">initialFilterValues</a></strong>()</code> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#isBound()">isBound</a></strong>()</code> +<div class="block">Returns true if all property filters are known to be properly + bound.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#isNotExists()">isNotExists</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#not()">not</a></strong>()</code> +<div class="block">Returns the logical negation of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html#unbind()">unbind</a></strong>()</code> +<div class="block">Undoes the effect of a bind operation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="getChainedProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChainedProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>> getChainedProperty()</pre> +<div class="block">Returns the join property that is being checked for existence or + non-existence. The last property in the chain is a one-to-many or + many-to-one join, but it is a many-to-one join only if the sub-filter is + also open.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>chained property whose last property is a join</dd></dl> +</li> +</ul> +<a name="getSubFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> getSubFilter()</pre> +<div class="block">Returns the filter applied to the join, which might be open. For a + many-to-one join, the sub-filter is always open.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>filter which is applied to last property of chain</dd></dl> +</li> +</ul> +<a name="isNotExists()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNotExists</h4> +<pre>public boolean isNotExists()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if this filter is testing for "not exists"</dd></dl> +</li> +</ul> +<a name="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>> not()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">Filter</a></code></strong></div> +<div class="block">Returns the logical negation of this filter.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="initialFilterValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialFilterValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>> initialFilterValues()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">Filter</a></code></strong></div> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter. Returns null if Filter has no parameters. + + <p>Note: The returned FilterValues instance may reference a different + filter instance than this one. Call getFilter to retrieve it. The + difference is caused by the filter property values being <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>bound</code></a>.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">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="accept(com.amazon.carbonado.filter.Visitor,java.lang.Object)"> +<!-- --> +</a><a name="accept(com.amazon.carbonado.filter.Visitor, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <R,P> R accept(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>,R,P> visitor, + P param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">Filter</a></code></strong></div> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">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>visitor</code> - visitor to traverse through the tree</dd><dd><code>param</code> - generic input parameter passed to visit methods</dd> +<dt><span class="strong">Returns:</span></dt><dd>generic return value passed from visit methods</dd></dl> +</li> +</ul> +<a name="bind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>> bind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">Filter</a></code></strong></div> +<div class="block">Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">bind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with bound property filters</dd></dl> +</li> +</ul> +<a name="unbind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unbind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>> unbind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">Filter</a></code></strong></div> +<div class="block">Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with unbound property filters</dd></dl> +</li> +</ul> +<a name="isBound()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBound</h4> +<pre>public boolean isBound()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">Filter</a></code></strong></div> +<div class="block">Returns true if all property filters are known to be properly + bound. This is a side effect of calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>Filter.bind()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()"><code>Filter.initialFilterValues()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()"><code>Filter.disjunctiveNormalForm()</code></a> or <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()"><code>Filter.conjunctiveNormalForm()</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">isBound</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">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="asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFromAny</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><T> asJoinedFromAny(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">Filter</a></code></strong></div> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">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="appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">Filter</a></code></strong></div> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optionally supply filter values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/ExistsFilter.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/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/ExistsFilter.html" target="_top">Frames</a></li> +<li><a href="ExistsFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/filter/Filter.NotJoined.html b/apidocs/com/amazon/carbonado/filter/Filter.NotJoined.html new file mode 100644 index 0000000..8be4c34 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/Filter.NotJoined.html @@ -0,0 +1,301 @@ +<!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>Filter.NotJoined (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="Filter.NotJoined (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/Filter.NotJoined.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/filter/Filter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/Filter.NotJoined.html" target="_top">Frames</a></li> +<li><a href="Filter.NotJoined.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.filter</div> +<h2 title="Class Filter.NotJoined" class="title">Class Filter.NotJoined</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.Filter.NotJoined</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">Filter.NotJoined</span> +extends java.lang.Object</pre> +<div class="block">Result from calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)"><code>Filter.notJoinedFrom(java.lang.String)</code></a>.</div> +</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html#getNotJoinedFilter()">getNotJoinedFilter</a></strong>()</code> +<div class="block">Returns the filter which is no longer as from a join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html#getRemainderFilter()">getRemainderFilter</a></strong>()</code> +<div class="block">Returns the filter which could not be separated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html#toString()">toString</a></strong>()</code> </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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="getNotJoinedFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNotJoinedFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> getNotJoinedFilter()</pre> +<div class="block">Returns the filter which is no longer as from a join.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>not joined filter or open filter if none</dd></dl> +</li> +</ul> +<a name="getRemainderFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> getRemainderFilter()</pre> +<div class="block">Returns the filter which could not be separated.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>remainder filter or open filter if none</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/Filter.NotJoined.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/filter/Filter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/Filter.NotJoined.html" target="_top">Frames</a></li> +<li><a href="Filter.NotJoined.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> diff --git a/apidocs/com/amazon/carbonado/filter/Filter.html b/apidocs/com/amazon/carbonado/filter/Filter.html new file mode 100644 index 0000000..93a2974 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/Filter.html @@ -0,0 +1,1151 @@ +<!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>Filter (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="Filter (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/Filter.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/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/Filter.html" target="_top">Frames</a></li> +<li><a href="Filter.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>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.filter</div> +<h2 title="Class Filter" class="title">Class Filter<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.filter.Filter<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a>, <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a>, <a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a>, <a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a>, <a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">Filter<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements java.io.Serializable, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">An immutable tree structure representing a query result filter. Filters can + be created using a builder pattern, by expression parsing, or by a + combination of techniques. Filter instances are canonical, which means that + equivalent instances can be compared for equality using the '==' operator. + + <p>Any method that accepts a filter expression parses against the following + syntax: + + <pre> + Filter = OrFilter + OrFilter = AndFilter { "|" AndFilter } + AndFilter = NotFilter { "&" NotFilter } + NotFilter = [ "!" ] EntityFilter + EntityFilter = PropertyFilter + | ChainedFilter + | "(" Filter ")" + PropertyFilter = ChainedProperty RelOp "?" + RelOp = "=" | "!=" | "<" | ">=" | ">" | "<=" + ChainedFilter = ChainedProperty "(" [ Filter ] ")" + ChainedProperty = Identifier + | InnerJoin "." ChainedProperty + | OuterJoin "." ChainedProperty + InnerJoin = Identifier + OuterJoin = "(" Identifier ")" + </pre></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="../../../../serialized-form.html#com.amazon.carbonado.filter.Filter">Serialized Form</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>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></strong></code> +<div class="block">Result from calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)"><code>notJoinedFrom(java.lang.String)</code></a>.</div> +</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>abstract <R,P> R</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>,R,P> visitor, + P param)</code> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a></strong>(java.lang.String expression)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator, + java.lang.Object constantValue)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "exists" test applied to a join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "not exists" test applied to a join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> values)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Prepends a join property to all properties of this filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a></strong>(java.lang.Class<T> type, + java.lang.String joinProperty)</code> +<div class="block">Prepends a join property to all properties of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">bind</a></strong>()</code> +<div class="block">Walks through each property filter, assigning a bind ID to it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a></strong>()</code> +<div class="block">Returns an equivalent filter that is in conjunctive normal form.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its conjunctive normal form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a></strong>()</code> +<div class="block">Returns an equivalent filter that is in disjunctive normal form.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its disjunctive normal form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a></strong>(java.lang.Class<S> type, + java.lang.String expression)</code> +<div class="block">Returns a cached filter instance that operates on the given type and + filter expression.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a cached filter instance that operates on the given type, which + allows all results to pass through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this filter operates on.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a></strong>()</code> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">isBound</a></strong>()</code> +<div class="block">Returns true if all property filters are known to be properly + bound.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed</a></strong>()</code> +<div class="block">Returns true if filter prevents any results from passing through.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen</a></strong>()</code> +<div class="block">Returns true if filter allows all results to pass through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a></strong>()</code> +<div class="block">Returns the logical negation of this filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> joinProperty)</code> +<div class="block">Removes a join property prefix from all applicable properties of this + filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a></strong>(java.lang.String joinProperty)</code> +<div class="block">Removes a join property prefix from all applicable properties of this + filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a></strong>(java.lang.String expression)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator, + java.lang.Object constantValue)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "exists" test applied to a join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "not exists" test applied to a + join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a></strong>()</code> +<div class="block">Returns an equivalent filter with redundant terms eliminated.</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/filter/Filter.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the string value of this filter, which is also parsable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></strong>()</code> +<div class="block">Undoes the effect of a bind operation.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="filterFor(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filterFor</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filterFor(java.lang.Class<S> type, + java.lang.String expression)</pre> +<div class="block">Returns a cached filter instance that operates on the given type and + filter expression.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable that query is made against</dd><dd><code>expression</code> - query filter expression to parse</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type or filter expression is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></code> - if filter expression is malformed</dd></dl> +</li> +</ul> +<a name="getOpenFilter(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOpenFilter</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><S> getOpenFilter(java.lang.Class<S> type)</pre> +<div class="block">Returns a cached filter instance that operates on the given type, which + allows all results to pass through.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable that query is made against</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter"><code>OpenFilter</code></a></dd></dl> +</li> +</ul> +<a name="getClosedFilter(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClosedFilter</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><S> getClosedFilter(java.lang.Class<S> type)</pre> +<div class="block">Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable that query is made against</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><code>ClosedFilter</code></a></dd></dl> +</li> +</ul> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>public java.lang.Class<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> getStorableType()</pre> +<div class="block">Returns the storable type that this filter operates on.</div> +</li> +</ul> +<a name="initialFilterValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialFilterValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> initialFilterValues()</pre> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter. Returns null if Filter has no parameters. + + <p>Note: The returned FilterValues instance may reference a different + filter instance than this one. Call getFilter to retrieve it. The + difference is caused by the filter property values being <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>bound</code></a>.</div> +</li> +</ul> +<a name="and(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> and(java.lang.String expression)</pre> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expression</code> - query filter expression to parse</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd></dl> +</li> +</ul> +<a name="and(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> and(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> filter)</pre> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd></dl> +</li> +</ul> +<a name="and(java.lang.String, com.amazon.carbonado.filter.RelOp)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> and(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator)</pre> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - property name to match on, which may be a chained property</dd><dd><code>operator</code> - relational operator</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not found</dd></dl> +</li> +</ul> +<a name="and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> and(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator, + java.lang.Object constantValue)</pre> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - property name to match on, which may be a chained property</dd><dd><code>operator</code> - relational operator</dd><dd><code>constantValue</code> - constant value to match</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not found</dd></dl> +</li> +</ul> +<a name="andExists(java.lang.String, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>andExists</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> andExists(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</pre> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "exists" test applied to a join.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - join property name, which may be a chained property</dd><dd><code>subFilter</code> - sub-filter to apply to join, which may be null to test + for any existing</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not found</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>andNotExists</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> andNotExists(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</pre> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "not exists" test applied to a join.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - join property name, which may be a chained property</dd><dd><code>subFilter</code> - sub-filter to apply to join, which may be null to test + for any not existing</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not found</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="or(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> or(java.lang.String expression)</pre> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expression</code> - query filter expression to parse</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd></dl> +</li> +</ul> +<a name="or(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> or(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> filter)</pre> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd></dl> +</li> +</ul> +<a name="or(java.lang.String, com.amazon.carbonado.filter.RelOp)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> or(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator)</pre> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - property name to match on, which may be a chained property</dd><dd><code>operator</code> - relational operator</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not found</dd></dl> +</li> +</ul> +<a name="or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> or(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator, + java.lang.Object constantValue)</pre> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - property name to match on, which may be a chained property</dd><dd><code>operator</code> - relational operator</dd><dd><code>constantValue</code> - constant value to match</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not found</dd></dl> +</li> +</ul> +<a name="orExists(java.lang.String, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orExists</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> orExists(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</pre> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "exists" test applied to a join.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - one-to-many join property name, which may be a chained property</dd><dd><code>subFilter</code> - sub-filter to apply to join, which may be null to test + for any existing</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not found</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orNotExists</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> orNotExists(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</pre> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "not exists" test applied to a + join.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - one-to-many join property name, which may be a chained property</dd><dd><code>subFilter</code> - sub-filter to apply to join, which may be null to test + for any not existing</dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not found</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public abstract <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> not()</pre> +<div class="block">Returns the logical negation of this filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="disjunctiveNormalForm()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disjunctiveNormalForm</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> disjunctiveNormalForm()</pre> +<div class="block">Returns an equivalent filter that is in disjunctive normal form. In this + form, all logical 'and' operations are performed before all logical 'or' + operations. This method often returns a filter with more terms than + before. + + <p>The tree is also normalized such that all terms in a common logical + operation are ordered left to right. For example, expressions of the + form <code>"(a = ? & b = ?) & (c = ? & d = ?)"</code> are converted to + <code>"(((a = ?) & (b = ?)) & c = ?) & d = ?"</code>. + + <p>Although the disjunctive normal filter may have more terms, it can be + used to extract values from a FilterValues instance created from this + filter. This works because the disjunctive normal filter is composed of + the same set of PropertyFilter instances.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="disjunctiveNormalFormSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disjunctiveNormalFormSplit</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>>> disjunctiveNormalFormSplit()</pre> +<div class="block">Splits the filter from its disjunctive normal form. Or'ng the filters + together produces the full disjunctive normal form.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of sub filters which don't perform any 'or' + operations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.1</dd></dl> +</li> +</ul> +<a name="conjunctiveNormalForm()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conjunctiveNormalForm</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> conjunctiveNormalForm()</pre> +<div class="block">Returns an equivalent filter that is in conjunctive normal form. In this + form, all logical 'or' operations are performed before all logical 'and' + operations. This method often returns a filter with more terms than + before. + + <p>The tree is also normalized such that all terms in a common logical + operation are ordered left to right. For example, expressions of the + form <code>"(a = ? | b = ?) | (c = ? | d = ?)"</code> are converted to + <code>"(((a = ?) | (b = ?)) | c = ?) | d = ?"</code>. + + <p>Although the conjunctive normal filter may have more terms, it can be + used to extract values from a FilterValues instance created from this + filter. This works because the conjunctive normal filter is composed of + the same set of PropertyFilter instances.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="conjunctiveNormalFormSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conjunctiveNormalFormSplit</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>>> conjunctiveNormalFormSplit()</pre> +<div class="block">Splits the filter from its conjunctive normal form. And'ng the filters + together produces the full conjunctive normal form.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of sub filters which don't perform any 'and' + operations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.1</dd></dl> +</li> +</ul> +<a name="accept(com.amazon.carbonado.filter.Visitor,java.lang.Object)"> +<!-- --> +</a><a name="accept(com.amazon.carbonado.filter.Visitor, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public abstract <R,P> R accept(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>,R,P> visitor, + P param)</pre> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor to traverse through the tree</dd><dd><code>param</code> - generic input parameter passed to visit methods</dd> +<dt><span class="strong">Returns:</span></dt><dd>generic return value passed from visit methods</dd></dl> +</li> +</ul> +<a name="bind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bind</h4> +<pre>public abstract <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> bind()</pre> +<div class="block">Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with bound property filters</dd></dl> +</li> +</ul> +<a name="unbind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unbind</h4> +<pre>public abstract <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> unbind()</pre> +<div class="block">Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with unbound property filters</dd></dl> +</li> +</ul> +<a name="isBound()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBound</h4> +<pre>public abstract boolean isBound()</pre> +<div class="block">Returns true if all property filters are known to be properly + bound. This is a side effect of calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>bind()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()"><code>initialFilterValues()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()"><code>disjunctiveNormalForm()</code></a> or <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()"><code>conjunctiveNormalForm()</code></a>.</div> +</li> +</ul> +<a name="reduce()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reduce</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> reduce()</pre> +<div class="block">Returns an equivalent filter with redundant terms eliminated. The tree + is also normalized such that all terms in a common logical operation are + ordered left to right. For example, expressions of the form + <code>"(a = ? & b = ?) & (c = ? & d = ?)"</code> are converted to + <code>"(((a = ?) & (b = ?)) & c = ?) & d = ?"</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="asJoinedFrom(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFrom</h4> +<pre>public final <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> asJoinedFrom(java.lang.Class<T> type, + java.lang.String joinProperty)</pre> +<div class="block">Prepends a join property to all properties of this filter. For example, + consider two Storable types, Person and Address. Person has a property + "homeAddress" which joins to Address. An Address filter, "city = ?", as + joined from Person's "homeAddress", becomes "homeAddress.city = ?". + + <pre> + Filter<Address> addressFilter = Filter.filterFor(Address.class, "city = ?"); + Filter<Person> personFilter = addressFilter.asJoinedFrom(Person.class, "homeAddress"); + + // Equivalent filter: + Filter<Person> personFilter2 = Filter.filterFor(Person.class, "homeAddress.city = ?"); + </pre></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of T which contains join property</dd><dd><code>joinProperty</code> - property of T which joins to this Filter's Storable type</dd> +<dt><span class="strong">Returns:</span></dt><dd>filter for type T</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property does not exist or is not a + join to type S</dd></dl> +</li> +</ul> +<a name="asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFrom</h4> +<pre>public final <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> asJoinedFrom(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</pre> +<div class="block">Prepends a join property to all properties of this filter. For example, + consider two Storable types, Person and Address. Person has a property + "homeAddress" which joins to Address. An Address filter, "city = ?", as + joined from Person's "homeAddress", becomes "homeAddress.city = ?".</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>joinProperty</code> - property of T which joins to this Filter's Storable type</dd> +<dt><span class="strong">Returns:</span></dt><dd>filter for type T</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is not a join to type S</dd></dl> +</li> +</ul> +<a name="asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFromAny</h4> +<pre>public abstract <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> asJoinedFromAny(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</pre> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</li> +</ul> +<a name="notJoinedFrom(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>notJoinedFrom</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a> notJoinedFrom(java.lang.String joinProperty)</pre> +<div class="block">Removes a join property prefix from all applicable properties of this + filter. For example, consider two Storable types, Person and + Address. Person has a property "homeAddress" which joins to Address. A + Person filter might be "homeAddress.city = ? & lastName = ?". When not + joined from "homeAddress", it becomes "city = ?" on Address with a + remainder of "lastName = ?" on Person. + + <p>The resulting remainder filter (if any) is always logically and'd to + the not joined filter. In order to achieve this, the original filter is + first converted to conjunctive normal form. And as a side affect, both + the remainder and not joined filters are <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>bound</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>joinProperty</code> - property to not join from</dd> +<dt><span class="strong">Returns:</span></dt><dd>not join result</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property does not exist or if + property does not refer to a Storable</dd></dl> +</li> +</ul> +<a name="notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>notJoinedFrom</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a> notJoinedFrom(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> joinProperty)</pre> +<div class="block">Removes a join property prefix from all applicable properties of this + filter. For example, consider two Storable types, Person and + Address. Person has a property "homeAddress" which joins to Address. A + Person filter might be "homeAddress.city = ? & lastName = ?". When not + joined from "homeAddress", it becomes "city = ?" on Address with a + remainder of "lastName = ?" on Person. + + <p>The resulting remainder filter (if any) is always logically and'd to + the not joined filter. In order to achieve this, the original filter is + first converted to conjunctive normal form. And as a side affect, both + the remainder and not joined filters are <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>bound</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>joinProperty</code> - property to not join from</dd> +<dt><span class="strong">Returns:</span></dt><dd>not join result</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property does not refer to a Storable</dd></dl> +</li> +</ul> +<a name="isOpen()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOpen</h4> +<pre>public boolean isOpen()</pre> +<div class="block">Returns true if filter allows all results to pass through.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isClosed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public boolean isClosed()</pre> +<div class="block">Returns true if filter prevents any results from passing through.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public final int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public abstract boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns the string value of this filter, which is also parsable.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</dd></dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public abstract void appendTo(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - optionally supply filter values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/Filter.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/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/Filter.html" target="_top">Frames</a></li> +<li><a href="Filter.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>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> diff --git a/apidocs/com/amazon/carbonado/filter/FilterValues.html b/apidocs/com/amazon/carbonado/filter/FilterValues.html new file mode 100644 index 0000000..6bf1751 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/FilterValues.html @@ -0,0 +1,677 @@ +<!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>FilterValues (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="FilterValues (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/FilterValues.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/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/FilterValues.html" target="_top">Frames</a></li> +<li><a href="FilterValues.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.filter</div> +<h2 title="Class FilterValues" class="title">Class FilterValues<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.filter.FilterValues<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FilterValues<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements java.io.Serializable, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Assigns values to <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders. FilterValues instances are + immutable.</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="../../../../serialized-form.html#com.amazon.carbonado.filter.FilterValues">Serialized Form</a></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/filter/FilterValues.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Append the string representation of this object to the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#getAssignedValue(com.amazon.carbonado.filter.PropertyFilter)">getAssignedValue</a></strong>(<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter)</code> +<div class="block">Returns the value assigned to the given PropertyFilter, throwing an + exception if not assigned.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#getBlankParameterCount()">getBlankParameterCount</a></strong>()</code> +<div class="block">Returns the amount of values yet to be assigned.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the Filter that this FilterValues instance applies to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#getSuppliedValues()">getSuppliedValues</a></strong>()</code> +<div class="block">Returns all supplied values in this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#getSuppliedValuesFor(com.amazon.carbonado.filter.Filter)">getSuppliedValuesFor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> filter)</code> +<div class="block">Returns all supplied values in this object, as required by the given + Filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#getValue(com.amazon.carbonado.filter.PropertyFilter)">getValue</a></strong>(<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter)</code> +<div class="block">Returns the value assigned to the given PropertyFilter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#getValues()">getValues</a></strong>()</code> +<div class="block">Returns all values in this object, including those provided by filter + constants.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#getValuesFor(com.amazon.carbonado.filter.Filter)">getValuesFor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> filter)</code> +<div class="block">Returns all values in this object, as required by the given Filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#isAssigned(com.amazon.carbonado.filter.PropertyFilter)">isAssigned</a></strong>(<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter)</code> +<div class="block">Returns true if a value is assigned to the given PropertyFilter.</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/filter/FilterValues.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the string value of the filter with any values substituted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/FilterValues.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameters filled in.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> getFilter()</pre> +<div class="block">Returns the Filter that this FilterValues instance applies to.</div> +</li> +</ul> +<a name="with(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(int value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(long value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(float value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(double value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(boolean value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(char value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(byte)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(byte value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(short)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(short value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="with(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> with(java.lang.Object value)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="withValues(java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> withValues(java.lang.Object... values)</pre> +<div class="block">Returns a new FilterValues instance with the next blank parameters filled in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - parameter values to fill in; if null or empty, this + FilterValues instance is returned</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no blank parameters or if too many + parameter values supplied</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type doesn't match</dd></dl> +</li> +</ul> +<a name="getBlankParameterCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlankParameterCount</h4> +<pre>public int getBlankParameterCount()</pre> +<div class="block">Returns the amount of values yet to be assigned.</div> +</li> +</ul> +<a name="getValue(com.amazon.carbonado.filter.PropertyFilter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValue</h4> +<pre>public java.lang.Object getValue(<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter)</pre> +<div class="block">Returns the value assigned to the given PropertyFilter. If null, value + may be unassigned. Call getAssignedValue to have an exception thrown + instead.</div> +</li> +</ul> +<a name="getAssignedValue(com.amazon.carbonado.filter.PropertyFilter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAssignedValue</h4> +<pre>public java.lang.Object getAssignedValue(<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter) + throws java.lang.IllegalStateException</pre> +<div class="block">Returns the value assigned to the given PropertyFilter, throwing an + exception if not assigned. Call getValue to have null returned instead.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if value is blank</dd></dl> +</li> +</ul> +<a name="isAssigned(com.amazon.carbonado.filter.PropertyFilter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAssigned</h4> +<pre>public boolean isAssigned(<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter)</pre> +<div class="block">Returns true if a value is assigned to the given PropertyFilter.</div> +</li> +</ul> +<a name="getValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValues</h4> +<pre>public java.lang.Object[] getValues() + throws java.lang.IllegalStateException</pre> +<div class="block">Returns all values in this object, including those provided by filter + constants. An IllegalStateException will result if any values are blank.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>new object array</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any values are blank</dd></dl> +</li> +</ul> +<a name="getSuppliedValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSuppliedValues</h4> +<pre>public java.lang.Object[] getSuppliedValues()</pre> +<div class="block">Returns all supplied values in this object. Constant filter values are + not included.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>new object array</dd></dl> +</li> +</ul> +<a name="getValuesFor(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValuesFor</h4> +<pre>public java.lang.Object[] getValuesFor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> filter) + throws java.lang.IllegalStateException</pre> +<div class="block">Returns all values in this object, as required by the given Filter. The + given Filter must be composed only of the same PropertyFilter instances + as used to construct this object. An IllegalStateException will result + otherwise.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - filter must be bound</dd> +<dt><span class="strong">Returns:</span></dt><dd>new object array</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if any values are blank</dd></dl> +</li> +</ul> +<a name="getSuppliedValuesFor(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSuppliedValuesFor</h4> +<pre>public java.lang.Object[] getSuppliedValuesFor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> filter) + throws java.lang.IllegalStateException</pre> +<div class="block">Returns all supplied values in this object, as required by the given + Filter. Constant filter values are not included. The given Filter must + be composed only of the same PropertyFilter instances as used to + construct this object. An IllegalStateException will result otherwise.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - filter must be bound</dd> +<dt><span class="strong">Returns:</span></dt><dd>new object array</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code></dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns the string value of the filter with any values substituted.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">Appender</a></code></strong></div> +<div class="block">Append the string representation of this object to the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</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/FilterValues.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/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/FilterValues.html" target="_top">Frames</a></li> +<li><a href="FilterValues.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> diff --git a/apidocs/com/amazon/carbonado/filter/OpenFilter.html b/apidocs/com/amazon/carbonado/filter/OpenFilter.html new file mode 100644 index 0000000..33bdada --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/OpenFilter.html @@ -0,0 +1,589 @@ +<!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>OpenFilter (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="OpenFilter (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/OpenFilter.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/filter/FilterValues.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/OpenFilter.html" target="_top">Frames</a></li> +<li><a href="OpenFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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.filter</div> +<h2 title="Class OpenFilter" class="title">Class OpenFilter<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><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.Filter</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.OpenFilter<S></li> +</ul> +</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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">OpenFilter<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S></pre> +<div class="block">Filter which lets all results pass through.</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="../../../../serialized-form.html#com.amazon.carbonado.filter.OpenFilter">Serialized Form</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></li> +</ul> +</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><R,P> R</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>,R,P> visitor, + P param)</code> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> values)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#bind()">bind</a></strong>()</code> +<div class="block">Walks through each property filter, assigning a bind ID to it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its conjunctive normal form.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its disjunctive normal form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#initialFilterValues()">initialFilterValues</a></strong>()</code> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#isBound()">isBound</a></strong>()</code> +<div class="block">Returns true if all property filters are known to be properly + bound.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#isOpen()">isOpen</a></strong>()</code> +<div class="block">Always returns true.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#not()">not</a></strong>()</code> +<div class="block">Returns the logical negation of this filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</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/filter/OpenFilter.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the string value of this filter, which is also parsable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html#unbind()">unbind</a></strong>()</code> +<div class="block">Undoes the effect of a bind operation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="isOpen()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOpen</h4> +<pre>public final boolean isOpen()</pre> +<div class="block">Always returns true.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">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="and(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> and(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> filter)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">Filter</a></code></strong></div> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="or(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> or(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> filter)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">Filter</a></code></strong></div> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> not()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">Filter</a></code></strong></div> +<div class="block">Returns the logical negation of this filter.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="disjunctiveNormalFormSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disjunctiveNormalFormSplit</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>>> disjunctiveNormalFormSplit()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">Filter</a></code></strong></div> +<div class="block">Splits the filter from its disjunctive normal form. Or'ng the filters + together produces the full disjunctive normal form.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of sub filters which don't perform any 'or' + operations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.1</dd></dl> +</li> +</ul> +<a name="conjunctiveNormalFormSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conjunctiveNormalFormSplit</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>>> conjunctiveNormalFormSplit()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">Filter</a></code></strong></div> +<div class="block">Splits the filter from its conjunctive normal form. And'ng the filters + together produces the full conjunctive normal form.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of sub filters which don't perform any 'and' + operations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.1</dd></dl> +</li> +</ul> +<a name="initialFilterValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialFilterValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> initialFilterValues()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">Filter</a></code></strong></div> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter. Returns null if Filter has no parameters. + + <p>Note: The returned FilterValues instance may reference a different + filter instance than this one. Call getFilter to retrieve it. The + difference is caused by the filter property values being <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>bound</code></a>.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">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="accept(com.amazon.carbonado.filter.Visitor,java.lang.Object)"> +<!-- --> +</a><a name="accept(com.amazon.carbonado.filter.Visitor, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <R,P> R accept(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>,R,P> visitor, + P param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">Filter</a></code></strong></div> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">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>visitor</code> - visitor to traverse through the tree</dd><dd><code>param</code> - generic input parameter passed to visit methods</dd> +<dt><span class="strong">Returns:</span></dt><dd>generic return value passed from visit methods</dd></dl> +</li> +</ul> +<a name="bind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> bind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">Filter</a></code></strong></div> +<div class="block">Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">bind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with bound property filters</dd></dl> +</li> +</ul> +<a name="unbind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unbind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> unbind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">Filter</a></code></strong></div> +<div class="block">Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with unbound property filters</dd></dl> +</li> +</ul> +<a name="isBound()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBound</h4> +<pre>public boolean isBound()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">Filter</a></code></strong></div> +<div class="block">Returns true if all property filters are known to be properly + bound. This is a side effect of calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>Filter.bind()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()"><code>Filter.initialFilterValues()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()"><code>Filter.disjunctiveNormalForm()</code></a> or <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()"><code>Filter.conjunctiveNormalForm()</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">isBound</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">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="asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFromAny</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><T> asJoinedFromAny(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">Filter</a></code></strong></div> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">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="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">Filter</a></code></strong></div> +<div class="block">Returns the string value of this filter, which is also parsable.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">toString</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">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="appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">Filter</a></code></strong></div> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optionally supply filter values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/OpenFilter.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/filter/FilterValues.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/OpenFilter.html" target="_top">Frames</a></li> +<li><a href="OpenFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/filter/OrFilter.html b/apidocs/com/amazon/carbonado/filter/OrFilter.html new file mode 100644 index 0000000..c18decb --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/OrFilter.html @@ -0,0 +1,392 @@ +<!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>OrFilter (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="OrFilter (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/OrFilter.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/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/OrFilter.html" target="_top">Frames</a></li> +<li><a href="OrFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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.filter</div> +<h2 title="Class OrFilter" class="title">Class OrFilter<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><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.Filter</a><S></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.BinaryOpFilter</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.OrFilter<S></li> +</ul> +</li> +</ul> +</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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">OrFilter<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a><S></pre> +<div class="block">Filter tree node that performs a logical 'or' test.</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="../../../../serialized-form.html#com.amazon.carbonado.filter.OrFilter">Serialized Form</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></li> +</ul> +</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><R,P> R</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OrFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>,R,P> visitor, + P param)</code> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OrFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>> values)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OrFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OrFilter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OrFilter.html#not()">not</a></strong>()</code> +<div class="block">Returns the logical negation of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/OrFilter.html#unbind()">unbind</a></strong>()</code> +<div class="block">Undoes the effect of a bind operation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.BinaryOpFilter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#bind()">bind</a>, <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#getLeftFilter()">getLeftFilter</a>, <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#getRightFilter()">getRightFilter</a>, <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#isBound()">isBound</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>> not()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">Filter</a></code></strong></div> +<div class="block">Returns the logical negation of this filter.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="accept(com.amazon.carbonado.filter.Visitor,java.lang.Object)"> +<!-- --> +</a><a name="accept(com.amazon.carbonado.filter.Visitor, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <R,P> R accept(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>,R,P> visitor, + P param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">Filter</a></code></strong></div> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">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>visitor</code> - visitor to traverse through the tree</dd><dd><code>param</code> - generic input parameter passed to visit methods</dd> +<dt><span class="strong">Returns:</span></dt><dd>generic return value passed from visit methods</dd></dl> +</li> +</ul> +<a name="unbind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unbind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>> unbind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">Filter</a></code></strong></div> +<div class="block">Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with unbound property filters</dd></dl> +</li> +</ul> +<a name="asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFromAny</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> asJoinedFromAny(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">Filter</a></code></strong></div> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">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="appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">Filter</a></code></strong></div> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optionally supply filter values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/OrFilter.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/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/OrFilter.html" target="_top">Frames</a></li> +<li><a href="OrFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/filter/PropertyFilter.html b/apidocs/com/amazon/carbonado/filter/PropertyFilter.html new file mode 100644 index 0000000..b783cc4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/PropertyFilter.html @@ -0,0 +1,609 @@ +<!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>PropertyFilter (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="PropertyFilter (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/PropertyFilter.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/filter/OrFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/PropertyFilter.html" target="_top">Frames</a></li> +<li><a href="PropertyFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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.filter</div> +<h2 title="Class PropertyFilter" class="title">Class PropertyFilter<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><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">com.amazon.carbonado.filter.Filter</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.PropertyFilter<S></li> +</ul> +</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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">PropertyFilter<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S></pre> +<div class="block">Filter tree node that performs a relational test against a specific property + value.</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="../../../../serialized-form.html#com.amazon.carbonado.filter.PropertyFilter">Serialized Form</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></li> +</ul> +</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><R,P> R</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>,R,P> visitor, + P param)</code> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>> values)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#bind()">bind</a></strong>()</code> +<div class="block">Walks through each property filter, assigning a bind ID to it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its conjunctive normal form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#constant()">constant</a></strong>()</code> +<div class="block">Returns the constant value of this PropertyFilter, which is valid only + if isConstant returns true.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#constant(java.lang.Object)">constant</a></strong>(java.lang.Object value)</code> +<div class="block">Returns another PropertyFilter instance which is bound to the given constant value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its disjunctive normal form.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#getBindID()">getBindID</a></strong>()</code> +<div class="block">Bind ID is used to distinguish this PropertyFilter instance from another + against the same property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#getBoxedType()">getBoxedType</a></strong>()</code> +<div class="block">Returns the type of the ChainedProperty property, boxed into an object + if primitive.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#getChainedProperty()">getChainedProperty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#getOperator()">getOperator</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#getType()">getType</a></strong>()</code> +<div class="block">Returns the type of the ChainedProperty.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#isBound()">isBound</a></strong>()</code> +<div class="block">Returns true if all property filters are known to be properly + bound.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#isConstant()">isConstant</a></strong>()</code> +<div class="block">Returns true if this PropertyFilter has a constant value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#not()">not</a></strong>()</code> +<div class="block">Returns the logical negation of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html#unbind()">unbind</a></strong>()</code> +<div class="block">Undoes the effect of a bind operation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.filter.Filter"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></h3> +<code><a href="../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>> not()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">Filter</a></code></strong></div> +<div class="block">Returns the logical negation of this filter.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance</dd></dl> +</li> +</ul> +<a name="disjunctiveNormalFormSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disjunctiveNormalFormSplit</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>>> disjunctiveNormalFormSplit()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">Filter</a></code></strong></div> +<div class="block">Splits the filter from its disjunctive normal form. Or'ng the filters + together produces the full disjunctive normal form.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of sub filters which don't perform any 'or' + operations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.1</dd></dl> +</li> +</ul> +<a name="conjunctiveNormalFormSplit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conjunctiveNormalFormSplit</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>>> conjunctiveNormalFormSplit()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">Filter</a></code></strong></div> +<div class="block">Splits the filter from its conjunctive normal form. And'ng the filters + together produces the full conjunctive normal form.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>unmodifiable list of sub filters which don't perform any 'and' + operations</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.1</dd></dl> +</li> +</ul> +<a name="accept(com.amazon.carbonado.filter.Visitor,java.lang.Object)"> +<!-- --> +</a><a name="accept(com.amazon.carbonado.filter.Visitor, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>accept</h4> +<pre>public <R,P> R accept(<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>,R,P> visitor, + P param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">Filter</a></code></strong></div> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">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>visitor</code> - visitor to traverse through the tree</dd><dd><code>param</code> - generic input parameter passed to visit methods</dd> +<dt><span class="strong">Returns:</span></dt><dd>generic return value passed from visit methods</dd></dl> +</li> +</ul> +<a name="getChainedProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChainedProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>> getChainedProperty()</pre> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public java.lang.Class<?> getType()</pre> +<div class="block">Returns the type of the ChainedProperty.</div> +</li> +</ul> +<a name="getBoxedType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoxedType</h4> +<pre>public java.lang.Class<?> getBoxedType()</pre> +<div class="block">Returns the type of the ChainedProperty property, boxed into an object + if primitive.</div> +</li> +</ul> +<a name="getOperator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOperator</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> getOperator()</pre> +</li> +</ul> +<a name="getBindID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBindID</h4> +<pre>public int getBindID()</pre> +<div class="block">Bind ID is used to distinguish this PropertyFilter instance from another + against the same property. For example, the filter "a = ? | a = ?" + references the property 'a' twice. Each '?' parameter is bound to a + different value, and so the bind ID for each property filter is + different. "a = ?[1] | a = ?[2]".</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>assigned bind ID, or 0 if unbound</dd></dl> +</li> +</ul> +<a name="bind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>> bind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">Filter</a></code></strong></div> +<div class="block">Walks through each property filter, assigning a bind ID to it. This step + is automatically performed for proper dnf/cnf conversion, and for + building FilterValues.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()">bind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with bound property filters</dd></dl> +</li> +</ul> +<a name="unbind()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unbind</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>> unbind()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">Filter</a></code></strong></div> +<div class="block">Undoes the effect of a bind operation. The returned filter might still + report itself as bound if it doesn't make a distinction between these + states.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>canonical Filter instance with unbound property filters</dd></dl> +</li> +</ul> +<a name="isBound()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBound</h4> +<pre>public boolean isBound()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">Filter</a></code></strong></div> +<div class="block">Returns true if all property filters are known to be properly + bound. This is a side effect of calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#bind()"><code>Filter.bind()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()"><code>Filter.initialFilterValues()</code></a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()"><code>Filter.disjunctiveNormalForm()</code></a> or <a href="../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()"><code>Filter.conjunctiveNormalForm()</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()">isBound</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">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="asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asJoinedFromAny</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><T> asJoinedFromAny(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">Filter</a></code></strong></div> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">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="constant(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constant</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>> constant(java.lang.Object value)</pre> +<div class="block">Returns another PropertyFilter instance which is bound to the given constant value.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if value is not compatible with property type</dd></dl> +</li> +</ul> +<a name="constant()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constant</h4> +<pre>public java.lang.Object constant()</pre> +<div class="block">Returns the constant value of this PropertyFilter, which is valid only + if isConstant returns true.</div> +</li> +</ul> +<a name="isConstant()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isConstant</h4> +<pre>public boolean isConstant()</pre> +<div class="block">Returns true if this PropertyFilter has a constant value.</div> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">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="appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">Filter</a></code></strong></div> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></code> in class <code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optionally supply filter values</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/PropertyFilter.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/filter/OrFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/PropertyFilter.html" target="_top">Frames</a></li> +<li><a href="PropertyFilter.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_classes_inherited_from_class_com.amazon.carbonado.filter.Filter">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/filter/RelOp.html b/apidocs/com/amazon/carbonado/filter/RelOp.html new file mode 100644 index 0000000..d675b01 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/RelOp.html @@ -0,0 +1,425 @@ +<!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>RelOp (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="RelOp (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/RelOp.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/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/RelOp.html" target="_top">Frames</a></li> +<li><a href="RelOp.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.filter</div> +<h2 title="Enum RelOp" class="title">Enum RelOp</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.RelOp</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">RelOp</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a>></pre> +<div class="block">Relational operator enumeration.</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"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ">EQ</a></strong></code> +<div class="block">Equals</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE">GE</a></strong></code> +<div class="block">Greator than or Equal</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT">GT</a></strong></code> +<div class="block">Greator Than</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE">LE</a></strong></code> +<div class="block">Less than or Equal</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT">LT</a></strong></code> +<div class="block">Less Than</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#NE">NE</a></strong></code> +<div class="block">Not Equals</div> +</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/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#reverse()">reverse</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#toString()">toString</a></strong>()</code> +<div class="block">Returns one of "=", "!=", "<", ">=", ">", or "<=".</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/RelOp.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="EQ"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EQ</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> EQ</pre> +<div class="block">Equals</div> +</li> +</ul> +<a name="NE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> NE</pre> +<div class="block">Not Equals</div> +</li> +</ul> +<a name="LT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LT</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> LT</pre> +<div class="block">Less Than</div> +</li> +</ul> +<a name="GE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> GE</pre> +<div class="block">Greator than or Equal</div> +</li> +</ul> +<a name="GT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GT</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> GT</pre> +<div class="block">Greator Than</div> +</li> +</ul> +<a name="LE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> LE</pre> +<div class="block">Less than or Equal</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (RelOp c : RelOp.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns one of "=", "!=", "<", ">=", ">", or "<=".</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Enum<<a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a>></code></dd> +</dl> +</li> +</ul> +<a name="reverse()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>reverse</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> reverse()</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/RelOp.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/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/RelOp.html" target="_top">Frames</a></li> +<li><a href="RelOp.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/filter/Visitor.html b/apidocs/com/amazon/carbonado/filter/Visitor.html new file mode 100644 index 0000000..aca92ed --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/Visitor.html @@ -0,0 +1,355 @@ +<!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>Visitor (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="Visitor (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/Visitor.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/filter/RelOp.html" title="enum in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/Visitor.html" target="_top">Frames</a></li> +<li><a href="Visitor.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><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.filter</div> +<h2 title="Class Visitor" class="title">Class Visitor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,R,P></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.filter.Visitor<S,R,P></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">Visitor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,R,P></span> +extends java.lang.Object</pre> +<div class="block">Traverses a filter tree in its canonical order. By overriding a visit + method, individual nodes can be captured and processed based on their + type. Call super.visit inside the overridden visit method to ensure that the + node's children are properly traversed.</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"> +<!-- ======== 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/filter/Visitor.html#Visitor()">Visitor</a></strong>()</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/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.AndFilter, P)">visit</a></strong>(<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.ClosedFilter, P)">visit</a></strong>(<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.ExistsFilter, P)">visit</a></strong>(<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.OpenFilter, P)">visit</a></strong>(<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.OrFilter, P)">visit</a></strong>(<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.PropertyFilter, P)">visit</a></strong>(<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </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> +</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="Visitor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Visitor</h4> +<pre>public Visitor()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="visit(com.amazon.carbonado.filter.OrFilter,java.lang.Object)"> +<!-- --> +</a><a name="visit(com.amazon.carbonado.filter.OrFilter, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a> visit(<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</pre> +</li> +</ul> +<a name="visit(com.amazon.carbonado.filter.AndFilter,java.lang.Object)"> +<!-- --> +</a><a name="visit(com.amazon.carbonado.filter.AndFilter, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a> visit(<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</pre> +</li> +</ul> +<a name="visit(com.amazon.carbonado.filter.PropertyFilter,java.lang.Object)"> +<!-- --> +</a><a name="visit(com.amazon.carbonado.filter.PropertyFilter, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a> visit(<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</pre> +</li> +</ul> +<a name="visit(com.amazon.carbonado.filter.ExistsFilter,java.lang.Object)"> +<!-- --> +</a><a name="visit(com.amazon.carbonado.filter.ExistsFilter, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a> visit(<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="visit(com.amazon.carbonado.filter.OpenFilter,java.lang.Object)"> +<!-- --> +</a><a name="visit(com.amazon.carbonado.filter.OpenFilter, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a> visit(<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</pre> +</li> +</ul> +<a name="visit(com.amazon.carbonado.filter.ClosedFilter,java.lang.Object)"> +<!-- --> +</a><a name="visit(com.amazon.carbonado.filter.ClosedFilter, P)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a> visit(<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</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/Visitor.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/filter/RelOp.html" title="enum in com.amazon.carbonado.filter"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/Visitor.html" target="_top">Frames</a></li> +<li><a href="Visitor.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><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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/AndFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/AndFilter.html new file mode 100644 index 0000000..e56c4d3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/AndFilter.html @@ -0,0 +1,160 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.AndFilter (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="Uses of Class com.amazon.carbonado.filter.AndFilter (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><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/AndFilter.html" target="_top">Frames</a></li> +<li><a href="AndFilter.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.AndFilter" class="title">Uses of Class<br>com.amazon.carbonado.filter.AndFilter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><span class="strong">Visitor.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.AndFilter, P)">visit</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a><<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/AndFilter.html" target="_top">Frames</a></li> +<li><a href="AndFilter.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/BinaryOpFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/BinaryOpFilter.html new file mode 100644 index 0000000..73d4ddc --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/BinaryOpFilter.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.BinaryOpFilter (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="Uses of Class com.amazon.carbonado.filter.BinaryOpFilter (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><a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/BinaryOpFilter.html" target="_top">Frames</a></li> +<li><a href="BinaryOpFilter.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.BinaryOpFilter" class="title">Uses of Class<br>com.amazon.carbonado.filter.BinaryOpFilter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a logical 'and' test.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a logical 'or' test.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/BinaryOpFilter.html" target="_top">Frames</a></li> +<li><a href="BinaryOpFilter.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/ClosedFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/ClosedFilter.html new file mode 100644 index 0000000..27a6ff4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/ClosedFilter.html @@ -0,0 +1,196 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.ClosedFilter (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="Uses of Class com.amazon.carbonado.filter.ClosedFilter (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><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/ClosedFilter.html" target="_top">Frames</a></li> +<li><a href="ClosedFilter.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.ClosedFilter" class="title">Uses of Class<br>com.amazon.carbonado.filter.ClosedFilter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><T></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#bind()">bind</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><S></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#not()">not</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#unbind()">unbind</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><span class="strong">Visitor.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.ClosedFilter, P)">visit</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/ClosedFilter.html" target="_top">Frames</a></li> +<li><a href="ClosedFilter.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/ExistsFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/ExistsFilter.html new file mode 100644 index 0000000..d8ec36e --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/ExistsFilter.html @@ -0,0 +1,181 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.ExistsFilter (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="Uses of Class com.amazon.carbonado.filter.ExistsFilter (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><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/ExistsFilter.html" target="_top">Frames</a></li> +<li><a href="ExistsFilter.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.ExistsFilter" class="title">Uses of Class<br>com.amazon.carbonado.filter.ExistsFilter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><T></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#bind()">bind</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#unbind()">unbind</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><span class="strong">Visitor.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.ExistsFilter, P)">visit</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/ExistsFilter.html" target="_top">Frames</a></li> +<li><a href="ExistsFilter.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/Filter.NotJoined.html b/apidocs/com/amazon/carbonado/filter/class-use/Filter.NotJoined.html new file mode 100644 index 0000000..b97b1b7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/Filter.NotJoined.html @@ -0,0 +1,169 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.Filter.NotJoined (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="Uses of Class com.amazon.carbonado.filter.Filter.NotJoined (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><a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/Filter.NotJoined.html" target="_top">Frames</a></li> +<li><a href="Filter.NotJoined.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.Filter.NotJoined" class="title">Uses of Class<br>com.amazon.carbonado.filter.Filter.NotJoined</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> joinProperty)</code> +<div class="block">Removes a join property prefix from all applicable properties of this + filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom</a></strong>(java.lang.String joinProperty)</code> +<div class="block">Removes a join property prefix from all applicable properties of this + filter.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/Filter.NotJoined.html" target="_top">Frames</a></li> +<li><a href="Filter.NotJoined.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/Filter.html b/apidocs/com/amazon/carbonado/filter/class-use/Filter.html new file mode 100644 index 0000000..e5999ae --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/Filter.html @@ -0,0 +1,1076 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.Filter (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="Uses of Class com.amazon.carbonado.filter.Filter (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><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/Filter.html" target="_top">Frames</a></li> +<li><a href="Filter.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.Filter" class="title">Uses of Class<br>com.amazon.carbonado.filter.Filter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a> in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../../com/amazon/carbonado/Query.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the query's filter.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>></code></td> +<td class="colLast"><span class="strong">Storage.</span><code><strong><a href="../../../../../com/amazon/carbonado/Storage.html#query(com.amazon.carbonado.filter.Filter)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a>> filter)</code> +<div class="block">Query for Storable instances against an explicitly constructed filter + object.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a> in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Cursor)">applyFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S> filterValues, + <a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Returns a Cursor that is filtered by the given Filter and FilterValues.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a logical 'and' test.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Base class for filter tree nodes that have a left and right child.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter which blocks any results from passing through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs an existence or non-existence test against a + join property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter which lets all results pass through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a logical 'or' test.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a relational test against a specific property + value.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and</a></strong>(java.lang.String expression)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator, + java.lang.Object constantValue)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "exists" test applied to a join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "not exists" test applied to a join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Prepends a join property to all properties of this filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom</a></strong>(java.lang.Class<T> type, + java.lang.String joinProperty)</code> +<div class="block">Prepends a join property to all properties of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">OrFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">AndFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#bind()">bind</a></strong>()</code> +<div class="block">Walks through each property filter, assigning a bind ID to it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>></code></td> +<td class="colLast"><span class="strong">BinaryOpFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#bind()">bind</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm</a></strong>()</code> +<div class="block">Returns an equivalent filter that is in conjunctive normal form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm</a></strong>()</code> +<div class="block">Returns an equivalent filter that is in disjunctive normal form.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor</a></strong>(java.lang.Class<S> type, + java.lang.String expression)</code> +<div class="block">Returns a cached filter instance that operates on the given type and + filter expression.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the Filter that this FilterValues instance applies to.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>></code></td> +<td class="colLast"><span class="strong">BinaryOpFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#getLeftFilter()">getLeftFilter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?></code></td> +<td class="colLast"><span class="strong">Filter.NotJoined.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html#getNotJoinedFilter()">getNotJoinedFilter</a></strong>()</code> +<div class="block">Returns the filter which is no longer as from a join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.NotJoined.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html#getRemainderFilter()">getRemainderFilter</a></strong>()</code> +<div class="block">Returns the filter which could not be separated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a>></code></td> +<td class="colLast"><span class="strong">BinaryOpFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html#getRightFilter()">getRightFilter</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#getSubFilter()">getSubFilter</a></strong>()</code> +<div class="block">Returns the filter applied to the join, which might be open.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OrFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html#not()">not</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>></code></td> +<td class="colLast"><span class="strong">AndFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html#not()">not</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#not()">not</a></strong>()</code> +<div class="block">Returns the logical negation of this filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#not()">not</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or</a></strong>(java.lang.String expression)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator, + java.lang.Object constantValue)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "exists" test applied to a join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "not exists" test applied to a + join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#reduce()">reduce</a></strong>()</code> +<div class="block">Returns an equivalent filter with redundant terms eliminated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OrFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html#unbind()">unbind</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>></code></td> +<td class="colLast"><span class="strong">AndFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html#unbind()">unbind</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#unbind()">unbind</a></strong>()</code> +<div class="block">Undoes the effect of a bind operation.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>>></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its conjunctive normal form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>>></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></strong>()</code> +<div class="block">Splits the filter from its disjunctive normal form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "exists" test applied to a join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "not exists" test applied to a join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#getSuppliedValuesFor(com.amazon.carbonado.filter.Filter)">getSuppliedValuesFor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> filter)</code> +<div class="block">Returns all supplied values in this object, as required by the given + Filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#getValuesFor(com.amazon.carbonado.filter.Filter)">getValuesFor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> filter)</code> +<div class="block">Returns all values in this object, as required by the given Filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> filter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "exists" test applied to a join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><?> subFilter)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "not exists" test applied to a + join.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilter()">getCoveringFilter</a></strong>()</code> +<div class="block">Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getCoveringFilter()">getCoveringFilter</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringRemainderFilter()">getCoveringRemainderFilter</a></strong>()</code> +<div class="block">Returns the composite remainder filter without including the covering + filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#getFilter()">getFilter</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns an open filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns an open filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns combined handled and remainder filter for this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the combined filter of the wrapped executor and the extra filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the combined filter of the wrapped executors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Always returns a <a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><code>ClosedFilter</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getHandledFilter()">getHandledFilter</a></strong>()</code> +<div class="block">Returns the composite handled filter, or null if no matches at all.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilter()">getIdentityFilter</a></strong>()</code> +<div class="block">Returns the composite identity filter, or null if no identity property + filters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilter()">getRemainderFilter</a></strong>()</code> +<div class="block">Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderFilter()">getRemainderFilter</a></strong>()</code> +<div class="block">Remainder filter which overrides that in composite score.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">mergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<? extends <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilters()">getCoveringFilters</a></strong>()</code> +<div class="block">Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<? extends <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilters()">getRemainderFilters</a></strong>()</code> +<div class="block">Returns the filters not supported by the evaluated index.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorCache.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainderFilter(com.amazon.carbonado.filter.Filter)">mergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter)</code> +<div class="block">Merges the remainder filter of this result with the given filter, + returning a new result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter)</code> +<div class="block">Returns a new or cached query for the given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> filter)</code> +<div class="block">Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> filter)</code> +<div class="block">Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderFilter)</code> +<div class="block">Returns a new result with the remainder filter replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">DelegatedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#FilteredQueryExecutor(com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.filter.Filter)">FilteredQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/Filter.html" target="_top">Frames</a></li> +<li><a href="Filter.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/FilterValues.html b/apidocs/com/amazon/carbonado/filter/class-use/FilterValues.html new file mode 100644 index 0000000..5e977ad --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/FilterValues.html @@ -0,0 +1,742 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.FilterValues (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="Uses of Class com.amazon.carbonado.filter.FilterValues (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><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/FilterValues.html" target="_top">Frames</a></li> +<li><a href="FilterValues.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.FilterValues" class="title">Uses of Class<br>com.amazon.carbonado.filter.FilterValues</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a> in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> that return <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a>></code></td> +<td class="colLast"><span class="strong">Query.</span><code><strong><a href="../../../../../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues</a></strong>()</code> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a> in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></code></td> +<td class="colLast"><span class="strong">FilteredCursor.</span><code><strong><a href="../../../../../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Cursor)">applyFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S> filterValues, + <a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Returns a Cursor that is filtered by the given Filter and FilterValues.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#initialFilterValues()">initialFilterValues</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues</a></strong>()</code> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#initialFilterValues()">initialFilterValues</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#initialFilterValues()">initialFilterValues</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>></code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Returns a new FilterValues instance with the next blank parameters filled in.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">OrFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">AndFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> values)</code> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo</a></strong>(java.lang.Appendable app, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> values)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#getFilterValues()">getFilterValues</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><span class="strong">EmptyQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html#getFilterValues()">getFilterValues</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Prints the native query to any appendable, if applicable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Prints native query of the wrapped executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">AbstractQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values)</code> +<div class="block">Does nothing and returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> +<div class="block">Prints native query of the wrapped executor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> +<div class="block">Prints native queries of the wrapped executors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/FilterValues.html" target="_top">Frames</a></li> +<li><a href="FilterValues.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/OpenFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/OpenFilter.html new file mode 100644 index 0000000..f480225 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/OpenFilter.html @@ -0,0 +1,196 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.OpenFilter (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="Uses of Class com.amazon.carbonado.filter.OpenFilter (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><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/OpenFilter.html" target="_top">Frames</a></li> +<li><a href="OpenFilter.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.OpenFilter" class="title">Uses of Class<br>com.amazon.carbonado.filter.OpenFilter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><T></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#bind()">bind</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><S></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a cached filter instance that operates on the given type, which + allows all results to pass through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#not()">not</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>> filter)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#unbind()">unbind</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><span class="strong">Visitor.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.OpenFilter, P)">visit</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/OpenFilter.html" target="_top">Frames</a></li> +<li><a href="OpenFilter.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/OrFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/OrFilter.html new file mode 100644 index 0000000..b42cf28 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/OrFilter.html @@ -0,0 +1,160 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.OrFilter (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="Uses of Class com.amazon.carbonado.filter.OrFilter (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><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/OrFilter.html" target="_top">Frames</a></li> +<li><a href="OrFilter.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.OrFilter" class="title">Uses of Class<br>com.amazon.carbonado.filter.OrFilter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><span class="strong">Visitor.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.OrFilter, P)">visit</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a><<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/OrFilter.html" target="_top">Frames</a></li> +<li><a href="OrFilter.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/PropertyFilter.html b/apidocs/com/amazon/carbonado/filter/class-use/PropertyFilter.html new file mode 100644 index 0000000..6d40e5f --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/PropertyFilter.html @@ -0,0 +1,279 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.PropertyFilter (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="Uses of Class com.amazon.carbonado.filter.PropertyFilter (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><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/PropertyFilter.html" target="_top">Frames</a></li> +<li><a href="PropertyFilter.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.PropertyFilter" class="title">Uses of Class<br>com.amazon.carbonado.filter.PropertyFilter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><T></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#bind()">bind</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#constant(java.lang.Object)">constant</a></strong>(java.lang.Object value)</code> +<div class="block">Returns another PropertyFilter instance which is bound to the given constant value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#not()">not</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#unbind()">unbind</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#getAssignedValue(com.amazon.carbonado.filter.PropertyFilter)">getAssignedValue</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter)</code> +<div class="block">Returns the value assigned to the given PropertyFilter, throwing an + exception if not assigned.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#getValue(com.amazon.carbonado.filter.PropertyFilter)">getValue</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter)</code> +<div class="block">Returns the value assigned to the given PropertyFilter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">FilterValues.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html#isAssigned(com.amazon.carbonado.filter.PropertyFilter)">isAssigned</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a>> propFilter)</code> +<div class="block">Returns true if a value is assigned to the given PropertyFilter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a></code></td> +<td class="colLast"><span class="strong">Visitor.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.PropertyFilter, P)">visit</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a> param)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeEndFilters()">getExclusiveRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeStartFilters()">getExclusiveRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilters()">getIdentityFilters</a></strong>()</code> +<div class="block">Returns the identity property filters supported by the evaluated + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeEndFilters()">getInclusiveRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeStartFilters()">getInclusiveRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()">getRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()">getRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/PropertyFilter.html" target="_top">Frames</a></li> +<li><a href="PropertyFilter.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/RelOp.html b/apidocs/com/amazon/carbonado/filter/class-use/RelOp.html new file mode 100644 index 0000000..cd424da --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/RelOp.html @@ -0,0 +1,219 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.RelOp (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="Uses of Class com.amazon.carbonado.filter.RelOp (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><a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/RelOp.html" target="_top">Frames</a></li> +<li><a href="RelOp.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.RelOp" class="title">Uses of Class<br>com.amazon.carbonado.filter.RelOp</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#getOperator()">getOperator</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></code></td> +<td class="colLast"><span class="strong">RelOp.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/RelOp.html#reverse()">reverse</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></code></td> +<td class="colLast"><span class="strong">RelOp.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/RelOp.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a>[]</code></td> +<td class="colLast"><span class="strong">RelOp.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/RelOp.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator, + java.lang.Object constantValue)</code> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a> operator, + java.lang.Object constantValue)</code> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/RelOp.html" target="_top">Frames</a></li> +<li><a href="RelOp.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> diff --git a/apidocs/com/amazon/carbonado/filter/class-use/Visitor.html b/apidocs/com/amazon/carbonado/filter/class-use/Visitor.html new file mode 100644 index 0000000..ea7b300 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/class-use/Visitor.html @@ -0,0 +1,192 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.filter.Visitor (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="Uses of Class com.amazon.carbonado.filter.Visitor (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><a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/Visitor.html" target="_top">Frames</a></li> +<li><a href="Visitor.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"> +<h2 title="Uses of Class com.amazon.carbonado.filter.Visitor" class="title">Uses of Class<br>com.amazon.carbonado.filter.Visitor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><R,P> R</code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>,R,P> visitor, + P param)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><R,P> R</code></td> +<td class="colLast"><span class="strong">OrFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a>,R,P> visitor, + P param)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><R,P> R</code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a>,R,P> visitor, + P param)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><R,P> R</code></td> +<td class="colLast"><span class="strong">AndFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a>,R,P> visitor, + P param)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <R,P> R</code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>,R,P> visitor, + P param)</code> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><R,P> R</code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>,R,P> visitor, + P param)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><R,P> R</code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><<a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a>,R,P> visitor, + P param)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/filter/class-use/Visitor.html" target="_top">Frames</a></li> +<li><a href="Visitor.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> diff --git a/apidocs/com/amazon/carbonado/filter/package-frame.html b/apidocs/com/amazon/carbonado/filter/package-frame.html new file mode 100644 index 0000000..68c5117 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/package-frame.html @@ -0,0 +1,33 @@ +<!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.filter (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/filter/package-summary.html" target="classFrame">com.amazon.carbonado.filter</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AndFilter.html" title="class in com.amazon.carbonado.filter" target="classFrame">AndFilter</a></li> +<li><a href="BinaryOpFilter.html" title="class in com.amazon.carbonado.filter" target="classFrame">BinaryOpFilter</a></li> +<li><a href="ClosedFilter.html" title="class in com.amazon.carbonado.filter" target="classFrame">ClosedFilter</a></li> +<li><a href="ExistsFilter.html" title="class in com.amazon.carbonado.filter" target="classFrame">ExistsFilter</a></li> +<li><a href="Filter.html" title="class in com.amazon.carbonado.filter" target="classFrame">Filter</a></li> +<li><a href="FilterValues.html" title="class in com.amazon.carbonado.filter" target="classFrame">FilterValues</a></li> +<li><a href="OpenFilter.html" title="class in com.amazon.carbonado.filter" target="classFrame">OpenFilter</a></li> +<li><a href="OrFilter.html" title="class in com.amazon.carbonado.filter" target="classFrame">OrFilter</a></li> +<li><a href="PropertyFilter.html" title="class in com.amazon.carbonado.filter" target="classFrame">PropertyFilter</a></li> +<li><a href="Visitor.html" title="class in com.amazon.carbonado.filter" target="classFrame">Visitor</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="RelOp.html" title="enum in com.amazon.carbonado.filter" target="classFrame">RelOp</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/filter/package-summary.html b/apidocs/com/amazon/carbonado/filter/package-summary.html new file mode 100644 index 0000000..31b4347 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/package-summary.html @@ -0,0 +1,220 @@ +<!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.filter (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.filter (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><a href="../../../../com/amazon/carbonado/cursor/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/gen/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/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.filter</h1> +<div class="docSummary"> +<div class="block">Contains classes for representing query filters.</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="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/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</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">Filter tree node that performs a logical 'and' test.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</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">Base class for filter tree nodes that have a left and right child.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</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">Filter which blocks any results from passing through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</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">Filter tree node that performs an existence or non-existence test against a + join property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</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">An immutable tree structure representing a query result filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</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">Assigns values to <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</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">Filter which lets all results pass through.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</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">Filter tree node that performs a logical 'or' test.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</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">Filter tree node that performs a relational test against a specific property + value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,R,P></td> +<td class="colLast"> +<div class="block">Traverses a filter tree in its canonical order.</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/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></td> +<td class="colLast"> +<div class="block">Relational operator enumeration.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.filter Description">Package com.amazon.carbonado.filter Description</h2> +<div class="block">Contains classes for representing query filters.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a></dd></dl> +</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><a href="../../../../com/amazon/carbonado/cursor/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/gen/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/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> diff --git a/apidocs/com/amazon/carbonado/filter/package-tree.html b/apidocs/com/amazon/carbonado/filter/package-tree.html new file mode 100644 index 0000000..0410ad2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/package-tree.html @@ -0,0 +1,158 @@ +<!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.filter Class Hierarchy (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.filter Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/cursor/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/gen/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.filter</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Filter</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">BinaryOpFilter</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">AndFilter</span></a><S></li> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">OrFilter</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">ClosedFilter</span></a><S></li> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">ExistsFilter</span></a><S></li> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">OpenFilter</span></a><S></li> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">PropertyFilter</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter"><span class="strong">Filter.NotJoined</span></a></li> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter"><span class="strong">FilterValues</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable)</li> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter"><span class="strong">Visitor</span></a><S,R,P></li> +</ul> +</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.filter.<a href="../../../../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter"><span class="strong">RelOp</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/cursor/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/gen/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/filter/package-use.html b/apidocs/com/amazon/carbonado/filter/package-use.html new file mode 100644 index 0000000..48fedce --- /dev/null +++ b/apidocs/com/amazon/carbonado/filter/package-use.html @@ -0,0 +1,302 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.filter (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="Uses of Package com.amazon.carbonado.filter (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.filter" class="title">Uses of Package<br>com.amazon.carbonado.filter</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> used by <a href="../../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/Filter.html#com.amazon.carbonado">Filter</a> +<div class="block">An immutable tree structure representing a query result filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/FilterValues.html#com.amazon.carbonado">FilterValues</a> +<div class="block">Assigns values to <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> used by <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/Filter.html#com.amazon.carbonado.cursor">Filter</a> +<div class="block">An immutable tree structure representing a query result filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/FilterValues.html#com.amazon.carbonado.cursor">FilterValues</a> +<div class="block">Assigns values to <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> used by <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/AndFilter.html#com.amazon.carbonado.filter">AndFilter</a> +<div class="block">Filter tree node that performs a logical 'and' test.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/BinaryOpFilter.html#com.amazon.carbonado.filter">BinaryOpFilter</a> +<div class="block">Base class for filter tree nodes that have a left and right child.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/ClosedFilter.html#com.amazon.carbonado.filter">ClosedFilter</a> +<div class="block">Filter which blocks any results from passing through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/ExistsFilter.html#com.amazon.carbonado.filter">ExistsFilter</a> +<div class="block">Filter tree node that performs an existence or non-existence test against a + join property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/Filter.html#com.amazon.carbonado.filter">Filter</a> +<div class="block">An immutable tree structure representing a query result filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/Filter.NotJoined.html#com.amazon.carbonado.filter">Filter.NotJoined</a> +<div class="block">Result from calling <a href="../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)"><code>Filter.notJoinedFrom(java.lang.String)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/FilterValues.html#com.amazon.carbonado.filter">FilterValues</a> +<div class="block">Assigns values to <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/OpenFilter.html#com.amazon.carbonado.filter">OpenFilter</a> +<div class="block">Filter which lets all results pass through.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/OrFilter.html#com.amazon.carbonado.filter">OrFilter</a> +<div class="block">Filter tree node that performs a logical 'or' test.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/PropertyFilter.html#com.amazon.carbonado.filter">PropertyFilter</a> +<div class="block">Filter tree node that performs a relational test against a specific property + value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/RelOp.html#com.amazon.carbonado.filter">RelOp</a> +<div class="block">Relational operator enumeration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/Visitor.html#com.amazon.carbonado.filter">Visitor</a> +<div class="block">Traverses a filter tree in its canonical order.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> used by <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/Filter.html#com.amazon.carbonado.qe">Filter</a> +<div class="block">An immutable tree structure representing a query result filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/FilterValues.html#com.amazon.carbonado.qe">FilterValues</a> +<div class="block">Assigns values to <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/filter/class-use/PropertyFilter.html#com.amazon.carbonado.qe">PropertyFilter</a> +<div class="block">Filter tree node that performs a relational test against a specific property + value.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/filter/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html b/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html new file mode 100644 index 0000000..c20d420 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/CodeBuilderUtil.html @@ -0,0 +1,792 @@ +<!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>CodeBuilderUtil (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="CodeBuilderUtil (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/CodeBuilderUtil.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/CodeBuilderUtil.html" target="_top">Frames</a></li> +<li><a href="CodeBuilderUtil.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><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.gen</div> +<h2 title="Class CodeBuilderUtil" class="title">Class CodeBuilderUtil</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.gen.CodeBuilderUtil</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">CodeBuilderUtil</span> +extends java.lang.Object</pre> +<div class="block">Collection of useful utilities for generating Carbonado code.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Don Schneider, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/gen/CodeBuilderUtil.html#CodeBuilderUtil()">CodeBuilderUtil</a></strong>()</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>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#addEqualsCall(org.cojen.classfile.CodeBuilder, java.lang.String, org.cojen.classfile.TypeDesc, boolean, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)">addEqualsCall</a></strong>(org.cojen.classfile.CodeBuilder b, + java.lang.String fieldName, + org.cojen.classfile.TypeDesc fieldType, + boolean testForNull, + org.cojen.classfile.Label fail, + org.cojen.classfile.LocalVariable other)</code> +<div class="block">Generates code to compare a field in this object against the same one in a + different instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#addValueHashCodeCall(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, boolean, boolean)">addValueHashCodeCall</a></strong>(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc valueType, + boolean testForNull, + boolean mixIn)</code> +<div class="block">Generates code to compute a hashcode for a value on the stack, consuming + the value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#addValuesEqualCall(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, boolean, org.cojen.classfile.Label, boolean)">addValuesEqualCall</a></strong>(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc valueType, + boolean testForNull, + org.cojen.classfile.Label label, + boolean choice)</code> +<div class="block">Generates code to compare two values on the stack, and branch to the + provided Label if they are not equal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#assertParameterNotNull(org.cojen.classfile.CodeBuilder, int)">assertParameterNotNull</a></strong>(org.cojen.classfile.CodeBuilder b, + int paramIndex)</code> +<div class="block">Generate code to throw an exception if a parameter is null</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static org.cojen.classfile.TypeDesc</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#bindQueryParam(java.lang.Class)">bindQueryParam</a></strong>(java.lang.Class clazz)</code> +<div class="block">Determines which overloaded "with" method on Query should be bound to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#blankValue(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc)">blankValue</a></strong>(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type)</code> +<div class="block">Generates code to push a blank value to the stack.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderAppendChar(org.cojen.classfile.CodeBuilder)">callStringBuilderAppendChar</a></strong>(org.cojen.classfile.CodeBuilder b)</code> +<div class="block">Appends a char to a StringBuilder.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderAppendString(org.cojen.classfile.CodeBuilder)">callStringBuilderAppendString</a></strong>(org.cojen.classfile.CodeBuilder b)</code> +<div class="block">Appends a String to a StringBuilder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderLength(org.cojen.classfile.CodeBuilder)">callStringBuilderLength</a></strong>(org.cojen.classfile.CodeBuilder b)</code> +<div class="block">Calls length on a StringBuilder on the stack, leaving an int on the stack.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderSetLength(org.cojen.classfile.CodeBuilder)">callStringBuilderSetLength</a></strong>(org.cojen.classfile.CodeBuilder b)</code> +<div class="block">Calls setLength on a StringBuilder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderToString(org.cojen.classfile.CodeBuilder)">callStringBuilderToString</a></strong>(org.cojen.classfile.CodeBuilder b)</code> +<div class="block">Calls toString on a StringBuilder.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#convertValue(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.Class)">convertValue</a></strong>(org.cojen.classfile.CodeBuilder b, + java.lang.Class from, + java.lang.Class to)</code> +<div class="block">Converts a value on the stack.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>org.cojen.classfile.ClassFile</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#createStorableClassFile(org.cojen.util.ClassInjector, java.lang.Class, boolean, java.lang.String)">createStorableClassFile</a></strong>(org.cojen.util.ClassInjector ci, + java.lang.Class<S> type, + boolean isAbstract, + java.lang.String aSourcefileName)</code> +<div class="block">Define a classfile appropriate for most Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#defineCopyBridges(org.cojen.classfile.ClassFile, java.lang.Class)">defineCopyBridges</a></strong>(org.cojen.classfile.ClassFile cf, + java.lang.Class leaf)</code> +<div class="block">Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#definePrepareBridges(org.cojen.classfile.ClassFile, java.lang.Class)">definePrepareBridges</a></strong>(org.cojen.classfile.ClassFile cf, + java.lang.Class leaf)</code> +<div class="block">Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#definePrepareMethod(org.cojen.classfile.ClassFile, java.lang.Class, org.cojen.classfile.TypeDesc)">definePrepareMethod</a></strong>(org.cojen.classfile.ClassFile cf, + java.lang.Class storableClass, + org.cojen.classfile.TypeDesc supportCtorType)</code> +<div class="block">Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#definePrepareMethod(org.cojen.classfile.ClassFile, java.lang.Class, org.cojen.classfile.TypeDesc, java.lang.String, org.cojen.classfile.TypeDesc)">definePrepareMethod</a></strong>(org.cojen.classfile.ClassFile cf, + java.lang.Class storableClass, + org.cojen.classfile.TypeDesc supportCtorType, + java.lang.String supportFieldName, + org.cojen.classfile.TypeDesc supportFieldType)</code> +<div class="block">Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Set<java.lang.Class></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#gatherAllBridgeTypes(java.util.Set, java.lang.Class)">gatherAllBridgeTypes</a></strong>(java.util.Set<java.lang.Class> set, + java.lang.Class leaf)</code> +<div class="block">Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#incrementVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc)">incrementVersion</a></strong>(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type)</code> +<div class="block">Generates code to increment a version property value, already on the stack.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#initialVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)">initialVersion</a></strong>(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type, + int value)</code> +<div class="block">Generates code to push an initial version property value on the stack.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#isPublicMethodFinal(java.lang.Class, java.lang.String, org.cojen.classfile.TypeDesc, org.cojen.classfile.TypeDesc[])">isPublicMethodFinal</a></strong>(java.lang.Class clazz, + java.lang.String name, + org.cojen.classfile.TypeDesc retType, + org.cojen.classfile.TypeDesc[] params)</code> +<div class="block">Returns true if a public final method exists which matches the given + specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#throwConcatException(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.String...)">throwConcatException</a></strong>(org.cojen.classfile.CodeBuilder b, + java.lang.Class type, + java.lang.String... messages)</code> +<div class="block">Generate code to throw an exception with a message concatenated at runtime.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#throwException(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.String)">throwException</a></strong>(org.cojen.classfile.CodeBuilder b, + java.lang.Class type, + java.lang.String message)</code> +<div class="block">Generate code to throw an exception with an optional message.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html#uneraseGenericParameter(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)">uneraseGenericParameter</a></strong>(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc paramType, + int paramIndex)</code> +<div class="block">Generate code to create a local variable containing the specified parameter coerced + to the specified type.</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> +</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="CodeBuilderUtil()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CodeBuilderUtil</h4> +<pre>public CodeBuilderUtil()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="assertParameterNotNull(org.cojen.classfile.CodeBuilder, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>assertParameterNotNull</h4> +<pre>public static void assertParameterNotNull(org.cojen.classfile.CodeBuilder b, + int paramIndex)</pre> +<div class="block">Generate code to throw an exception if a parameter is null</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - CodeBuilder into which to append the code</dd><dd><code>paramIndex</code> - index of the parameter to check</dd></dl> +</li> +</ul> +<a name="uneraseGenericParameter(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>uneraseGenericParameter</h4> +<pre>public static org.cojen.classfile.LocalVariable uneraseGenericParameter(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc paramType, + int paramIndex)</pre> +<div class="block">Generate code to create a local variable containing the specified parameter coerced + to the specified type. This is useful for re-interpreting erased generics into + the more specific genericized type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - CodeBuilder into which to append the code</dd><dd><code>paramType</code> - the more specific type which was erased during compilation</dd><dd><code>paramIndex</code> - index of the parameter to unerase</dd> +<dt><span class="strong">Returns:</span></dt><dd>a local variable referencing the type-cast parameter</dd></dl> +</li> +</ul> +<a name="throwException(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>throwException</h4> +<pre>public static void throwException(org.cojen.classfile.CodeBuilder b, + java.lang.Class type, + java.lang.String message)</pre> +<div class="block">Generate code to throw an exception with an optional message.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - <code>CodeBuilder</code> to which to add code</dd><dd><code>type</code> - type of the object to throw</dd><dd><code>message</code> - optional message to provide to the constructor</dd></dl> +</li> +</ul> +<a name="throwConcatException(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>throwConcatException</h4> +<pre>public static void throwConcatException(org.cojen.classfile.CodeBuilder b, + java.lang.Class type, + java.lang.String... messages)</pre> +<div class="block">Generate code to throw an exception with a message concatenated at runtime.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - <code>CodeBuilder</code> to which to add code</dd><dd><code>type</code> - type of the object to throw</dd><dd><code>messages</code> - messages to concat at runtime</dd></dl> +</li> +</ul> +<a name="gatherAllBridgeTypes(java.util.Set, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>gatherAllBridgeTypes</h4> +<pre>public static java.util.Set<java.lang.Class> gatherAllBridgeTypes(java.util.Set<java.lang.Class> set, + java.lang.Class leaf)</pre> +<div class="block">Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class). Eg, for Object<foo>, all + classes and implemented interfaces for every superclass between foo (the leaf) and + Object (the base). + <P>A copy must be coercible into any of these types, and copy bridge methods must be + provided to do so. + + <P>Note that the official documentation for this is in draft form, and you have to be + psychic to have figured out the necessity in the first place.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>set</code> - set into which the class types will be collected</dd><dd><code>leaf</code> - leaf class</dd> +<dt><span class="strong">Returns:</span></dt><dd>same set as was passed in</dd></dl> +</li> +</ul> +<a name="defineCopyBridges(org.cojen.classfile.ClassFile, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>defineCopyBridges</h4> +<pre>public static void defineCopyBridges(org.cojen.classfile.ClassFile cf, + java.lang.Class leaf)</pre> +<div class="block">Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cf</code> - file to which to add the copy bridge</dd><dd><code>leaf</code> - leaf class</dd></dl> +</li> +</ul> +<a name="definePrepareMethod(org.cojen.classfile.ClassFile, java.lang.Class, org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>definePrepareMethod</h4> +<pre>public static void definePrepareMethod(org.cojen.classfile.ClassFile cf, + java.lang.Class storableClass, + org.cojen.classfile.TypeDesc supportCtorType)</pre> +<div class="block">Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cf</code> - file to which to add the prepare method</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="definePrepareMethod(org.cojen.classfile.ClassFile, java.lang.Class, org.cojen.classfile.TypeDesc, java.lang.String, org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>definePrepareMethod</h4> +<pre>public static void definePrepareMethod(org.cojen.classfile.ClassFile cf, + java.lang.Class storableClass, + org.cojen.classfile.TypeDesc supportCtorType, + java.lang.String supportFieldName, + org.cojen.classfile.TypeDesc supportFieldType)</pre> +<div class="block">Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cf</code> - file to which to add the prepare method</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="definePrepareBridges(org.cojen.classfile.ClassFile, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>definePrepareBridges</h4> +<pre>public static void definePrepareBridges(org.cojen.classfile.ClassFile cf, + java.lang.Class leaf)</pre> +<div class="block">Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cf</code> - file to which to add the prepare bridge</dd><dd><code>leaf</code> - leaf class</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isPublicMethodFinal(java.lang.Class, java.lang.String, org.cojen.classfile.TypeDesc, org.cojen.classfile.TypeDesc[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPublicMethodFinal</h4> +<pre>public static boolean isPublicMethodFinal(java.lang.Class clazz, + java.lang.String name, + org.cojen.classfile.TypeDesc retType, + org.cojen.classfile.TypeDesc[] params)</pre> +<div class="block">Returns true if a public final method exists which matches the given + specification.</div> +</li> +</ul> +<a name="createStorableClassFile(org.cojen.util.ClassInjector, java.lang.Class, boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStorableClassFile</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> org.cojen.classfile.ClassFile createStorableClassFile(org.cojen.util.ClassInjector ci, + java.lang.Class<S> type, + boolean isAbstract, + java.lang.String aSourcefileName)</pre> +<div class="block">Define a classfile appropriate for most Storables. Specifically: + <ul> + <li>implements Storable</li> + <li>implements Cloneable + <li>abstract if appropriate + <li>marked synthetic + <li>targetted for java version 1.5 + </ul></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ci</code> - ClassInjector for the storable</dd><dd><code>type</code> - specific Storable implementation to generate</dd><dd><code>isAbstract</code> - true if the class should be abstract</dd><dd><code>aSourcefileName</code> - identifier for the classfile, typically the factory class name</dd> +<dt><span class="strong">Returns:</span></dt><dd>ClassFile object ready to have methods added.</dd></dl> +</li> +</ul> +<a name="addValueHashCodeCall(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValueHashCodeCall</h4> +<pre>public static void addValueHashCodeCall(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc valueType, + boolean testForNull, + boolean mixIn)</pre> +<div class="block">Generates code to compute a hashcode for a value on the stack, consuming + the value. After the code executes, the stack contains an int hashcode.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - <code>CodeBuilder</code> to which to add the code</dd><dd><code>valueType</code> - the type of the value</dd><dd><code>testForNull</code> - if true and the value is a reference and might be null</dd><dd><code>mixIn</code> - if true, stack has an existing hashcode followed by a value</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</dd></dl> +</li> +</ul> +<a name="addEqualsCall(org.cojen.classfile.CodeBuilder, java.lang.String, org.cojen.classfile.TypeDesc, boolean, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEqualsCall</h4> +<pre>public static void addEqualsCall(org.cojen.classfile.CodeBuilder b, + java.lang.String fieldName, + org.cojen.classfile.TypeDesc fieldType, + boolean testForNull, + org.cojen.classfile.Label fail, + org.cojen.classfile.LocalVariable other)</pre> +<div class="block">Generates code to compare a field in this object against the same one in a + different instance. Branch to the provided Label if they are not equal.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - <code>CodeBuilder</code> to which to add the code</dd><dd><code>fieldName</code> - the name of the field</dd><dd><code>fieldType</code> - the type of the field</dd><dd><code>testForNull</code> - if true and the values are references, they will be considered + unequal unless neither or both are null. If false, assume neither is null.</dd><dd><code>fail</code> - the label to branch to</dd><dd><code>other</code> - the other instance to test</dd></dl> +</li> +</ul> +<a name="addValuesEqualCall(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, boolean, org.cojen.classfile.Label, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addValuesEqualCall</h4> +<pre>public static void addValuesEqualCall(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc valueType, + boolean testForNull, + org.cojen.classfile.Label label, + boolean choice)</pre> +<div class="block">Generates code to compare two values on the stack, and branch to the + provided Label if they are not equal. Both values must be of the same + type. If they are floating point values, NaN is considered equal to NaN, + which is inconsistent with the usual treatment for NaN. + + <P>The generated instruction consumes both values on the stack.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - <code>CodeBuilder</code> to which to add the code</dd><dd><code>valueType</code> - the type of the values</dd><dd><code>testForNull</code> - if true and the values are references, they will be considered + unequal unless neither or both are null. If false, assume neither is null.</dd><dd><code>label</code> - the label to branch to</dd><dd><code>choice</code> - when true, branch to label if values are equal, else + branch to label if values are unequal.</dd></dl> +</li> +</ul> +<a name="convertValue(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertValue</h4> +<pre>public static void convertValue(org.cojen.classfile.CodeBuilder b, + java.lang.Class from, + java.lang.Class to)</pre> +<div class="block">Converts a value on the stack. If "to" type is a String, then conversion + may call the String.valueOf(from).</div> +</li> +</ul> +<a name="initialVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialVersion</h4> +<pre>public static void initialVersion(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type, + int value) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates code to push an initial version property value on the stack.</div> +<dl><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 version type is not supported</dd></dl> +</li> +</ul> +<a name="incrementVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>incrementVersion</h4> +<pre>public static void incrementVersion(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates code to increment a version property value, already on the stack.</div> +<dl><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 version type is not supported</dd></dl> +</li> +</ul> +<a name="blankValue(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>blankValue</h4> +<pre>public static void blankValue(org.cojen.classfile.CodeBuilder b, + org.cojen.classfile.TypeDesc type)</pre> +<div class="block">Generates code to push a blank value to the stack. For objects, it is + null, and for primitive types it is zero or false.</div> +</li> +</ul> +<a name="bindQueryParam(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindQueryParam</h4> +<pre>public static org.cojen.classfile.TypeDesc bindQueryParam(java.lang.Class clazz)</pre> +<div class="block">Determines which overloaded "with" method on Query should be bound to.</div> +</li> +</ul> +<a name="callStringBuilderAppendString(org.cojen.classfile.CodeBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>callStringBuilderAppendString</h4> +<pre>public static void callStringBuilderAppendString(org.cojen.classfile.CodeBuilder b)</pre> +<div class="block">Appends a String to a StringBuilder. A StringBuilder and String must be + on the stack, and a StringBuilder is left on the stack after the call.</div> +</li> +</ul> +<a name="callStringBuilderAppendChar(org.cojen.classfile.CodeBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>callStringBuilderAppendChar</h4> +<pre>public static void callStringBuilderAppendChar(org.cojen.classfile.CodeBuilder b)</pre> +<div class="block">Appends a char to a StringBuilder. A StringBuilder and char must be on + the stack, and a StringBuilder is left on the stack after the call.</div> +</li> +</ul> +<a name="callStringBuilderLength(org.cojen.classfile.CodeBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>callStringBuilderLength</h4> +<pre>public static void callStringBuilderLength(org.cojen.classfile.CodeBuilder b)</pre> +<div class="block">Calls length on a StringBuilder on the stack, leaving an int on the stack.</div> +</li> +</ul> +<a name="callStringBuilderSetLength(org.cojen.classfile.CodeBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>callStringBuilderSetLength</h4> +<pre>public static void callStringBuilderSetLength(org.cojen.classfile.CodeBuilder b)</pre> +<div class="block">Calls setLength on a StringBuilder. A StringBuilder and int must be on + the stack, and both are consumed after the call.</div> +</li> +</ul> +<a name="callStringBuilderToString(org.cojen.classfile.CodeBuilder)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>callStringBuilderToString</h4> +<pre>public static void callStringBuilderToString(org.cojen.classfile.CodeBuilder b)</pre> +<div class="block">Calls toString on a StringBuilder. A StringBuilder must be on the stack, + and a String is left on the stack after the call.</div> +</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/CodeBuilderUtil.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/CodeBuilderUtil.html" target="_top">Frames</a></li> +<li><a href="CodeBuilderUtil.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><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> diff --git a/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html b/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html new file mode 100644 index 0000000..7217bbf --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/CommonMethodNames.html @@ -0,0 +1,1091 @@ +<!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>CommonMethodNames (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="CommonMethodNames (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/CommonMethodNames.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/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/CommonMethodNames.html" target="_top">Frames</a></li> +<li><a href="CommonMethodNames.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.gen</div> +<h2 title="Class CommonMethodNames" class="title">Class CommonMethodNames</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.gen.CommonMethodNames</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">CommonMethodNames</span> +extends java.lang.Object</pre> +<div class="block">Collection of constant method names for the public API.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#AND_METHOD_NAME">AND_METHOD_NAME</a></strong></code> +<div class="block">Query API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#CLONE_METHOD_NAME">CLONE_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#COMMIT_METHOD_NAME">COMMIT_METHOD_NAME</a></strong></code> +<div class="block">Transaction API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_ALL_PROPERTIES">COPY_ALL_PROPERTIES</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_DIRTY_PROPERTIES">COPY_DIRTY_PROPERTIES</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_METHOD_NAME">COPY_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_PRIMARY_KEY_PROPERTIES">COPY_PRIMARY_KEY_PROPERTIES</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_UNEQUAL_PROPERTIES">COPY_UNEQUAL_PROPERTIES</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_VERSION_PROPERTY">COPY_VERSION_PROPERTY</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#DELETE_METHOD_NAME">DELETE_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#ENTER_TRANSACTION_METHOD_NAME">ENTER_TRANSACTION_METHOD_NAME</a></strong></code> +<div class="block">Repository API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#EQUAL_PRIMARY_KEYS_METHOD_NAME">EQUAL_PRIMARY_KEYS_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#EQUAL_PROPERTIES_METHOD_NAME">EQUAL_PROPERTIES_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#EQUALS_METHOD_NAME">EQUALS_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#EXIT_METHOD_NAME">EXIT_METHOD_NAME</a></strong></code> +<div class="block">Transaction API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#FETCH_METHOD_NAME">FETCH_METHOD_NAME</a></strong></code> +<div class="block">Query API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#GET_PROPERTY_VALUE">GET_PROPERTY_VALUE</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME">GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME</a></strong></code> +<div class="block">Repository API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#HAS_DIRTY_PROPERTIES">HAS_DIRTY_PROPERTIES</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#HASHCODE_METHOD_NAME">HASHCODE_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#INSERT_METHOD_NAME">INSERT_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_CLEAN">IS_PROPERTY_CLEAN</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_DIRTY">IS_PROPERTY_DIRTY</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_SUPPORTED">IS_PROPERTY_SUPPORTED</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_UNINITIALIZED">IS_PROPERTY_UNINITIALIZED</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#LOAD_METHOD_NAME">LOAD_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#LOAD_ONE_METHOD_NAME">LOAD_ONE_METHOD_NAME</a></strong></code> +<div class="block">Query API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#MARK_ALL_PROPERTIES_CLEAN">MARK_ALL_PROPERTIES_CLEAN</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#MARK_ALL_PROPERTIES_DIRTY">MARK_ALL_PROPERTIES_DIRTY</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#MARK_PROPERTIES_CLEAN">MARK_PROPERTIES_CLEAN</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#MARK_PROPERTIES_DIRTY">MARK_PROPERTIES_DIRTY</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#PREPARE_METHOD_NAME">PREPARE_METHOD_NAME</a></strong></code> +<div class="block">Storage API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#PROPERTY_MAP">PROPERTY_MAP</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#QUERY_METHOD_NAME">QUERY_METHOD_NAME</a></strong></code> +<div class="block">Storage API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#READ_FROM">READ_FROM</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#SET_FOR_UPDATE_METHOD_NAME">SET_FOR_UPDATE_METHOD_NAME</a></strong></code> +<div class="block">Transaction API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#SET_PROPERTY_VALUE">SET_PROPERTY_VALUE</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#STORABLE_TYPE_METHOD_NAME">STORABLE_TYPE_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#STORAGE_FOR_METHOD_NAME">STORAGE_FOR_METHOD_NAME</a></strong></code> +<div class="block">Repository API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#TO_STRING_KEY_ONLY_METHOD_NAME">TO_STRING_KEY_ONLY_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#TO_STRING_METHOD_NAME">TO_STRING_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_DELETE_METHOD_NAME">TRY_DELETE_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_INSERT_METHOD_NAME">TRY_INSERT_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_LOAD_METHOD_NAME">TRY_LOAD_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_LOAD_ONE_METHOD_NAME">TRY_LOAD_ONE_METHOD_NAME</a></strong></code> +<div class="block">Query API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_UPDATE_METHOD_NAME">TRY_UPDATE_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#UPDATE_METHOD_NAME">UPDATE_METHOD_NAME</a></strong></code> +<div class="block">Storable API method name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#WITH_METHOD_NAME">WITH_METHOD_NAME</a></strong></code> +<div class="block">Query API method name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html#WRITE_TO">WRITE_TO</a></strong></code> +<div class="block">Storable API method name</div> +</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/gen/CommonMethodNames.html#CommonMethodNames()">CommonMethodNames</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="LOAD_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOAD_METHOD_NAME</h4> +<pre>public static final java.lang.String LOAD_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.LOAD_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="INSERT_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INSERT_METHOD_NAME</h4> +<pre>public static final java.lang.String INSERT_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.INSERT_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="UPDATE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UPDATE_METHOD_NAME</h4> +<pre>public static final java.lang.String UPDATE_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.UPDATE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DELETE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DELETE_METHOD_NAME</h4> +<pre>public static final java.lang.String DELETE_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.DELETE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TRY_LOAD_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRY_LOAD_METHOD_NAME</h4> +<pre>public static final java.lang.String TRY_LOAD_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.TRY_LOAD_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TRY_INSERT_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRY_INSERT_METHOD_NAME</h4> +<pre>public static final java.lang.String TRY_INSERT_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.TRY_INSERT_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TRY_UPDATE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRY_UPDATE_METHOD_NAME</h4> +<pre>public static final java.lang.String TRY_UPDATE_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.TRY_UPDATE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TRY_DELETE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRY_DELETE_METHOD_NAME</h4> +<pre>public static final java.lang.String TRY_DELETE_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.TRY_DELETE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="STORABLE_TYPE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STORABLE_TYPE_METHOD_NAME</h4> +<pre>public static final java.lang.String STORABLE_TYPE_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.STORABLE_TYPE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="COPY_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COPY_METHOD_NAME</h4> +<pre>public static final java.lang.String COPY_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.COPY_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CLONE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CLONE_METHOD_NAME</h4> +<pre>public static final java.lang.String CLONE_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.CLONE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="COPY_ALL_PROPERTIES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COPY_ALL_PROPERTIES</h4> +<pre>public static final java.lang.String COPY_ALL_PROPERTIES</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.COPY_ALL_PROPERTIES">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="COPY_PRIMARY_KEY_PROPERTIES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COPY_PRIMARY_KEY_PROPERTIES</h4> +<pre>public static final java.lang.String COPY_PRIMARY_KEY_PROPERTIES</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.COPY_PRIMARY_KEY_PROPERTIES">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="COPY_VERSION_PROPERTY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COPY_VERSION_PROPERTY</h4> +<pre>public static final java.lang.String COPY_VERSION_PROPERTY</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.COPY_VERSION_PROPERTY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="COPY_UNEQUAL_PROPERTIES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COPY_UNEQUAL_PROPERTIES</h4> +<pre>public static final java.lang.String COPY_UNEQUAL_PROPERTIES</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.COPY_UNEQUAL_PROPERTIES">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="COPY_DIRTY_PROPERTIES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COPY_DIRTY_PROPERTIES</h4> +<pre>public static final java.lang.String COPY_DIRTY_PROPERTIES</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.COPY_DIRTY_PROPERTIES">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="HAS_DIRTY_PROPERTIES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HAS_DIRTY_PROPERTIES</h4> +<pre>public static final java.lang.String HAS_DIRTY_PROPERTIES</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.HAS_DIRTY_PROPERTIES">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MARK_PROPERTIES_CLEAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MARK_PROPERTIES_CLEAN</h4> +<pre>public static final java.lang.String MARK_PROPERTIES_CLEAN</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.MARK_PROPERTIES_CLEAN">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MARK_ALL_PROPERTIES_CLEAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MARK_ALL_PROPERTIES_CLEAN</h4> +<pre>public static final java.lang.String MARK_ALL_PROPERTIES_CLEAN</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.MARK_ALL_PROPERTIES_CLEAN">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MARK_PROPERTIES_DIRTY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MARK_PROPERTIES_DIRTY</h4> +<pre>public static final java.lang.String MARK_PROPERTIES_DIRTY</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.MARK_PROPERTIES_DIRTY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="MARK_ALL_PROPERTIES_DIRTY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MARK_ALL_PROPERTIES_DIRTY</h4> +<pre>public static final java.lang.String MARK_ALL_PROPERTIES_DIRTY</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.MARK_ALL_PROPERTIES_DIRTY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_PROPERTY_UNINITIALIZED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_PROPERTY_UNINITIALIZED</h4> +<pre>public static final java.lang.String IS_PROPERTY_UNINITIALIZED</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.IS_PROPERTY_UNINITIALIZED">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_PROPERTY_DIRTY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_PROPERTY_DIRTY</h4> +<pre>public static final java.lang.String IS_PROPERTY_DIRTY</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.IS_PROPERTY_DIRTY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_PROPERTY_CLEAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_PROPERTY_CLEAN</h4> +<pre>public static final java.lang.String IS_PROPERTY_CLEAN</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.IS_PROPERTY_CLEAN">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_PROPERTY_SUPPORTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_PROPERTY_SUPPORTED</h4> +<pre>public static final java.lang.String IS_PROPERTY_SUPPORTED</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.IS_PROPERTY_SUPPORTED">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="GET_PROPERTY_VALUE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GET_PROPERTY_VALUE</h4> +<pre>public static final java.lang.String GET_PROPERTY_VALUE</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.GET_PROPERTY_VALUE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="SET_PROPERTY_VALUE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SET_PROPERTY_VALUE</h4> +<pre>public static final java.lang.String SET_PROPERTY_VALUE</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.SET_PROPERTY_VALUE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_MAP"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_MAP</h4> +<pre>public static final java.lang.String PROPERTY_MAP</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.PROPERTY_MAP">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="WRITE_TO"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WRITE_TO</h4> +<pre>public static final java.lang.String WRITE_TO</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.WRITE_TO">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="READ_FROM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>READ_FROM</h4> +<pre>public static final java.lang.String READ_FROM</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.READ_FROM">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TO_STRING_KEY_ONLY_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TO_STRING_KEY_ONLY_METHOD_NAME</h4> +<pre>public static final java.lang.String TO_STRING_KEY_ONLY_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.TO_STRING_KEY_ONLY_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TO_STRING_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TO_STRING_METHOD_NAME</h4> +<pre>public static final java.lang.String TO_STRING_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.TO_STRING_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="HASHCODE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HASHCODE_METHOD_NAME</h4> +<pre>public static final java.lang.String HASHCODE_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.HASHCODE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EQUALS_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EQUALS_METHOD_NAME</h4> +<pre>public static final java.lang.String EQUALS_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.EQUALS_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EQUAL_PRIMARY_KEYS_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EQUAL_PRIMARY_KEYS_METHOD_NAME</h4> +<pre>public static final java.lang.String EQUAL_PRIMARY_KEYS_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.EQUAL_PRIMARY_KEYS_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EQUAL_PROPERTIES_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EQUAL_PROPERTIES_METHOD_NAME</h4> +<pre>public static final java.lang.String EQUAL_PROPERTIES_METHOD_NAME</pre> +<div class="block">Storable API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.EQUAL_PROPERTIES_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="QUERY_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>QUERY_METHOD_NAME</h4> +<pre>public static final java.lang.String QUERY_METHOD_NAME</pre> +<div class="block">Storage API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.QUERY_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PREPARE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PREPARE_METHOD_NAME</h4> +<pre>public static final java.lang.String PREPARE_METHOD_NAME</pre> +<div class="block">Storage API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.PREPARE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="LOAD_ONE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOAD_ONE_METHOD_NAME</h4> +<pre>public static final java.lang.String LOAD_ONE_METHOD_NAME</pre> +<div class="block">Query API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.LOAD_ONE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TRY_LOAD_ONE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRY_LOAD_ONE_METHOD_NAME</h4> +<pre>public static final java.lang.String TRY_LOAD_ONE_METHOD_NAME</pre> +<div class="block">Query API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.TRY_LOAD_ONE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="AND_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AND_METHOD_NAME</h4> +<pre>public static final java.lang.String AND_METHOD_NAME</pre> +<div class="block">Query API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.AND_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="WITH_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WITH_METHOD_NAME</h4> +<pre>public static final java.lang.String WITH_METHOD_NAME</pre> +<div class="block">Query API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.WITH_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="FETCH_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FETCH_METHOD_NAME</h4> +<pre>public static final java.lang.String FETCH_METHOD_NAME</pre> +<div class="block">Query API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.FETCH_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="STORAGE_FOR_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STORAGE_FOR_METHOD_NAME</h4> +<pre>public static final java.lang.String STORAGE_FOR_METHOD_NAME</pre> +<div class="block">Repository API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.STORAGE_FOR_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ENTER_TRANSACTION_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ENTER_TRANSACTION_METHOD_NAME</h4> +<pre>public static final java.lang.String ENTER_TRANSACTION_METHOD_NAME</pre> +<div class="block">Repository API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.ENTER_TRANSACTION_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME</h4> +<pre>public static final java.lang.String GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME</pre> +<div class="block">Repository API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="SET_FOR_UPDATE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SET_FOR_UPDATE_METHOD_NAME</h4> +<pre>public static final java.lang.String SET_FOR_UPDATE_METHOD_NAME</pre> +<div class="block">Transaction API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.SET_FOR_UPDATE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="COMMIT_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COMMIT_METHOD_NAME</h4> +<pre>public static final java.lang.String COMMIT_METHOD_NAME</pre> +<div class="block">Transaction API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.COMMIT_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EXIT_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EXIT_METHOD_NAME</h4> +<pre>public static final java.lang.String EXIT_METHOD_NAME</pre> +<div class="block">Transaction API method name</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.CommonMethodNames.EXIT_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CommonMethodNames()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CommonMethodNames</h4> +<pre>public CommonMethodNames()</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/CommonMethodNames.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/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/CommonMethodNames.html" target="_top">Frames</a></li> +<li><a href="CommonMethodNames.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><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html new file mode 100644 index 0000000..30c113f --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DelegateStorableGenerator.html @@ -0,0 +1,245 @@ +<!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>DelegateStorableGenerator (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="DelegateStorableGenerator (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/DelegateStorableGenerator.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/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/DelegateStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="DelegateStorableGenerator.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.gen</div> +<h2 title="Class DelegateStorableGenerator" class="title">Class DelegateStorableGenerator<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.gen.DelegateStorableGenerator<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DelegateStorableGenerator<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Generates and caches concrete implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + which delegate to <a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a>. The delegating classes extend + those generated by <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html#getDelegateClass(java.lang.Class, java.util.EnumSet)">getDelegateClass</a></strong>(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features)</code> +<div class="block">Delegate class has a constructor that accepts a <a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a> + instance.</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> +</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="getDelegateClass(java.lang.Class, java.util.EnumSet)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDelegateClass</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> java.lang.Class<? extends S> getDelegateClass(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Delegate class has a constructor that accepts a <a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a> + instance. + + <pre> + public <init>(DelegateSupport); + </pre></div> +<dl><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></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/DelegateStorableGenerator.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/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/DelegateStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="DelegateStorableGenerator.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> diff --git a/apidocs/com/amazon/carbonado/gen/DelegateSupport.html b/apidocs/com/amazon/carbonado/gen/DelegateSupport.html new file mode 100644 index 0000000..eb2b2cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DelegateSupport.html @@ -0,0 +1,298 @@ +<!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>DelegateSupport (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="DelegateSupport (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/DelegateSupport.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/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/DelegateSupport.html" target="_top">Frames</a></li> +<li><a href="DelegateSupport.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.gen</div> +<h2 title="Interface DelegateSupport" class="title">Interface DelegateSupport<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">DelegateSupport<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/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html#doTryDelete(S)">doTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html#doTryInsert(S)">doTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html#doTryLoad(S)">doTryLoad</a></strong>(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html#doTryUpdate(S)">doTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable)</code> </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="doTryLoad(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="doTryLoad(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doTryLoad</h4> +<pre>boolean doTryLoad(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><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="doTryInsert(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="doTryInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doTryInsert</h4> +<pre>boolean doTryInsert(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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></dd></dl> +</li> +</ul> +<a name="doTryUpdate(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="doTryUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doTryUpdate</h4> +<pre>boolean doTryUpdate(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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></dd></dl> +</li> +</ul> +<a name="doTryDelete(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="doTryDelete(S)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>doTryDelete</h4> +<pre>boolean doTryDelete(<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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></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/DelegateSupport.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/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/DelegateSupport.html" target="_top">Frames</a></li> +<li><a href="DelegateSupport.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> diff --git a/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html b/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html new file mode 100644 index 0000000..3d2c468 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/DetachedStorableFactory.html @@ -0,0 +1,267 @@ +<!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>DetachedStorableFactory (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="DetachedStorableFactory (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/DetachedStorableFactory.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/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/DetachedStorableFactory.html" target="_top">Frames</a></li> +<li><a href="DetachedStorableFactory.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><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.gen</div> +<h2 title="Class DetachedStorableFactory" class="title">Class DetachedStorableFactory<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.gen.DetachedStorableFactory<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DetachedStorableFactory<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Creates <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> instances which are basic data containers. All load + and store operations throw an exception, as do accesses to join properties.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</dd> +<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"> +<!-- ======== 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/gen/DetachedStorableFactory.html#DetachedStorableFactory(java.lang.Class)">DetachedStorableFactory</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="type parameter in DetachedStorableFactory">S</a>> type)</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><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>S</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html#newInstance()">newInstance</a></strong>()</code> </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> +</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="DetachedStorableFactory(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DetachedStorableFactory</h4> +<pre>public DetachedStorableFactory(java.lang.Class<<a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="type parameter in DetachedStorableFactory">S</a>> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><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></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="newInstance()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>newInstance</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> S newInstance()</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/DetachedStorableFactory.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/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/DetachedStorableFactory.html" target="_top">Frames</a></li> +<li><a href="DetachedStorableFactory.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><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> diff --git a/apidocs/com/amazon/carbonado/gen/MasterFeature.html b/apidocs/com/amazon/carbonado/gen/MasterFeature.html new file mode 100644 index 0000000..1a3e680 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/MasterFeature.html @@ -0,0 +1,501 @@ +<!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>MasterFeature (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="MasterFeature (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/MasterFeature.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/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/MasterFeature.html" target="_top">Frames</a></li> +<li><a href="MasterFeature.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.gen</div> +<h2 title="Enum MasterFeature" class="title">Enum MasterFeature</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.gen.MasterFeature</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">MasterFeature</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>></pre> +<div class="block">Master feature to enable when using <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#DELETE_TXN">DELETE_TXN</a></strong></code> +<div class="block">Ensure delete operation always is in a transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#DELETE_TXN_FOR_UPDATE">DELETE_TXN_FOR_UPDATE</a></strong></code> +<div class="block">Ensure delete operation always is in a transaction, "for update".</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#INSERT_CHECK_REQUIRED">INSERT_CHECK_REQUIRED</a></strong></code> +<div class="block">Insert operation checks that all required data properties have been set, + excluding automatic properties and version property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#INSERT_NO_CHECK_PRIMARY_PK">INSERT_NO_CHECK_PRIMARY_PK</a></strong></code> +<div class="block">Insert operation never checks if primary key is filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#INSERT_SEQUENCES">INSERT_SEQUENCES</a></strong></code> +<div class="block">Insert operation applies any sequences to unset properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#INSERT_TXN">INSERT_TXN</a></strong></code> +<div class="block">Ensure insert operation always is in a transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#INSERT_TXN_FOR_UPDATE">INSERT_TXN_FOR_UPDATE</a></strong></code> +<div class="block">Ensure insert operation always is in a transaction, "for update".</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#NORMALIZE">NORMALIZE</a></strong></code> +<div class="block">Insert and update operations normalize property types such as BigDecimal.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#PARTITIONING">PARTITIONING</a></strong></code> +<div class="block">Enforce rules for Storables which have a partition key</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#UPDATE_FULL">UPDATE_FULL</a></strong></code> +<div class="block">Update operations load clean copy first, to prevent destructive update.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#UPDATE_TXN">UPDATE_TXN</a></strong></code> +<div class="block">Ensure update operation always is in a transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#UPDATE_TXN_FOR_UPDATE">UPDATE_TXN_FOR_UPDATE</a></strong></code> +<div class="block">Ensure update operation always is in a transaction, "for update".</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#VERSIONING">VERSIONING</a></strong></code> +<div class="block">Insert and update operations implement record versioning, if version property exists.</div> +</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>static <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterFeature.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="VERSIONING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VERSIONING</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> VERSIONING</pre> +<div class="block">Insert and update operations implement record versioning, if version property exists.</div> +</li> +</ul> +<a name="NORMALIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NORMALIZE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> NORMALIZE</pre> +<div class="block">Insert and update operations normalize property types such as BigDecimal.</div> +</li> +</ul> +<a name="UPDATE_FULL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UPDATE_FULL</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> UPDATE_FULL</pre> +<div class="block">Update operations load clean copy first, to prevent destructive update.</div> +</li> +</ul> +<a name="UPDATE_TXN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UPDATE_TXN</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> UPDATE_TXN</pre> +<div class="block">Ensure update operation always is in a transaction.</div> +</li> +</ul> +<a name="UPDATE_TXN_FOR_UPDATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UPDATE_TXN_FOR_UPDATE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> UPDATE_TXN_FOR_UPDATE</pre> +<div class="block">Ensure update operation always is in a transaction, "for update".</div> +</li> +</ul> +<a name="INSERT_SEQUENCES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INSERT_SEQUENCES</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> INSERT_SEQUENCES</pre> +<div class="block">Insert operation applies any sequences to unset properties.</div> +</li> +</ul> +<a name="INSERT_CHECK_REQUIRED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INSERT_CHECK_REQUIRED</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> INSERT_CHECK_REQUIRED</pre> +<div class="block">Insert operation checks that all required data properties have been set, + excluding automatic properties and version property.</div> +</li> +</ul> +<a name="INSERT_NO_CHECK_PRIMARY_PK"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INSERT_NO_CHECK_PRIMARY_PK</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> INSERT_NO_CHECK_PRIMARY_PK</pre> +<div class="block">Insert operation never checks if primary key is filled in.</div> +</li> +</ul> +<a name="INSERT_TXN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INSERT_TXN</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> INSERT_TXN</pre> +<div class="block">Ensure insert operation always is in a transaction.</div> +</li> +</ul> +<a name="INSERT_TXN_FOR_UPDATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INSERT_TXN_FOR_UPDATE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> INSERT_TXN_FOR_UPDATE</pre> +<div class="block">Ensure insert operation always is in a transaction, "for update".</div> +</li> +</ul> +<a name="DELETE_TXN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DELETE_TXN</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> DELETE_TXN</pre> +<div class="block">Ensure delete operation always is in a transaction.</div> +</li> +</ul> +<a name="DELETE_TXN_FOR_UPDATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DELETE_TXN_FOR_UPDATE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> DELETE_TXN_FOR_UPDATE</pre> +<div class="block">Ensure delete operation always is in a transaction, "for update".</div> +</li> +</ul> +<a name="PARTITIONING"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PARTITIONING</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> PARTITIONING</pre> +<div class="block">Enforce rules for Storables which have a partition key</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (MasterFeature c : MasterFeature.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/MasterFeature.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/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/MasterFeature.html" target="_top">Frames</a></li> +<li><a href="MasterFeature.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/gen/MasterStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/MasterStorableGenerator.html new file mode 100644 index 0000000..0c82aa7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/MasterStorableGenerator.html @@ -0,0 +1,363 @@ +<!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>MasterStorableGenerator (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="MasterStorableGenerator (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/MasterStorableGenerator.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/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/MasterStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="MasterStorableGenerator.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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.gen</div> +<h2 title="Class MasterStorableGenerator" class="title">Class MasterStorableGenerator<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.gen.MasterStorableGenerator<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">MasterStorableGenerator<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + suitable for use by master repositories. The generated classes extend those + generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>. Subclasses need not worry about + transactions since this class takes care of that.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Olga Kuznetsova</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html#DO_TRY_DELETE_MASTER_METHOD_NAME">DO_TRY_DELETE_MASTER_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html#DO_TRY_INSERT_MASTER_METHOD_NAME">DO_TRY_INSERT_MASTER_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html#DO_TRY_LOAD_MASTER_METHOD_NAME">DO_TRY_LOAD_MASTER_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html#DO_TRY_UPDATE_MASTER_METHOD_NAME">DO_TRY_UPDATE_MASTER_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</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>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html#getAbstractClass(java.lang.Class, java.util.EnumSet)">getAbstractClass</a></strong>(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which + is fully thread-safe.</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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DO_TRY_LOAD_MASTER_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_LOAD_MASTER_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_LOAD_MASTER_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.MasterStorableGenerator.DO_TRY_LOAD_MASTER_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_INSERT_MASTER_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_INSERT_MASTER_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_INSERT_MASTER_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.MasterStorableGenerator.DO_TRY_INSERT_MASTER_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_UPDATE_MASTER_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_UPDATE_MASTER_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_UPDATE_MASTER_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.MasterStorableGenerator.DO_TRY_UPDATE_MASTER_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_DELETE_MASTER_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DO_TRY_DELETE_MASTER_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_DELETE_MASTER_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.MasterStorableGenerator.DO_TRY_DELETE_MASTER_METHOD_NAME">Constant Field Values</a></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="getAbstractClass(java.lang.Class, java.util.EnumSet)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAbstractClass</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + java.lang.IllegalArgumentException</pre> +<div class="block">Returns an abstract implementation of the given Storable type, which + is fully thread-safe. The Storable type itself may be an interface or + a class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. The constructor for the returned abstract + class looks like this: + + <pre> + public <init>(MasterSupport); + </pre> + + Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + <pre> + // Load the object by examining the primary key. + protected abstract boolean doTryLoad() throws FetchException; + + // Insert the object into the storage layer. + protected abstract boolean doTryInsert_master() throws PersistException; + + // Update the object in the storage. + protected abstract boolean doTryUpdate_master() throws PersistException; + + // Delete the object from the storage layer by the primary key. + protected abstract boolean doTryDelete_master() throws PersistException; + </pre> + + Subclasses can access the MasterSupport instance via the protected field + named by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#SUPPORT_FIELD_NAME"><code>SUPPORT_FIELD_NAME</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if Storable type is not well-formed</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><code>MasterSupport</code></a></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/MasterStorableGenerator.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/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/MasterStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="MasterStorableGenerator.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/gen/MasterSupport.html b/apidocs/com/amazon/carbonado/gen/MasterSupport.html new file mode 100644 index 0000000..26380cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/MasterSupport.html @@ -0,0 +1,246 @@ +<!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>MasterSupport (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="MasterSupport (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/MasterSupport.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/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/MasterSupport.html" target="_top">Frames</a></li> +<li><a href="MasterSupport.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.gen</div> +<h2 title="Interface MasterSupport" class="title">Interface MasterSupport<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/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> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a><S>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S>, <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">MasterSupport<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/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a><S></pre> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Returns a sequence value producer by name, or throw PersistException if not found.</div> +</td> +</tr> +</table> +<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="getSequenceValueProducer(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSequenceValueProducer</h4> +<pre><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> getSequenceValueProducer(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a sequence value producer by name, or throw PersistException if not found. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</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></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/MasterSupport.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/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/MasterSupport.html" target="_top">Frames</a></li> +<li><a href="MasterSupport.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> diff --git a/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html b/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html new file mode 100644 index 0000000..452304b --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableCopier.From.html @@ -0,0 +1,228 @@ +<!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>StorableCopier.From (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="StorableCopier.From (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/StorableCopier.From.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/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableCopier.From.html" target="_top">Frames</a></li> +<li><a href="StorableCopier.From.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.gen</div> +<h2 title="Class StorableCopier.From" class="title">Class StorableCopier.From<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.gen.StorableCopier.From<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a><<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">StorableCopier.From<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +</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><T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a><<a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="type parameter in StorableCopier.From">S</a>,T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html#to(java.lang.Class)">to</a></strong>(java.lang.Class<T> target)</code> </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> +</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="to(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>to</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a><<a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="type parameter in StorableCopier.From">S</a>,T> to(java.lang.Class<T> target)</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/StorableCopier.From.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/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableCopier.From.html" target="_top">Frames</a></li> +<li><a href="StorableCopier.From.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> diff --git a/apidocs/com/amazon/carbonado/gen/StorableCopier.html b/apidocs/com/amazon/carbonado/gen/StorableCopier.html new file mode 100644 index 0000000..2d49f89 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableCopier.html @@ -0,0 +1,370 @@ +<!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>StorableCopier (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="StorableCopier (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/StorableCopier.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/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableCopier.html" target="_top">Frames</a></li> +<li><a href="StorableCopier.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.gen</div> +<h2 title="Class StorableCopier" class="title">Class StorableCopier<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T 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.gen.StorableCopier<S,T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">StorableCopier<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Copies properties between otherwise incompatible Storables. Only matched + properties are copied, and primitive types are converted.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</dd> +<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"> +<!-- ======== 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 class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a><<a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="type parameter in StorableCopier.From">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html#StorableCopier()">StorableCopier</a></strong>()</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>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html#copyAllProperties(S, T)">copyAllProperties</a></strong>(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html#copyDirtyProperties(S, T)">copyDirtyProperties</a></strong>(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html#copyPrimaryKeyProperties(S, T)">copyPrimaryKeyProperties</a></strong>(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html#copyUnequalProperties(S, T)">copyUnequalProperties</a></strong>(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html#copyVersionProperty(S, T)">copyVersionProperty</a></strong>(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html#from(java.lang.Class)">from</a></strong>(java.lang.Class<S> source)</code> </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> +</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="StorableCopier()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorableCopier</h4> +<pre>protected StorableCopier()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="from(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>from</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a><S> from(java.lang.Class<S> source)</pre> +</li> +</ul> +<a name="copyAllProperties(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyAllProperties(S, T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyAllProperties</h4> +<pre>public abstract void copyAllProperties(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</pre> +</li> +</ul> +<a name="copyPrimaryKeyProperties(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyPrimaryKeyProperties(S, T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyPrimaryKeyProperties</h4> +<pre>public abstract void copyPrimaryKeyProperties(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</pre> +</li> +</ul> +<a name="copyVersionProperty(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyVersionProperty(S, T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyVersionProperty</h4> +<pre>public abstract void copyVersionProperty(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</pre> +</li> +</ul> +<a name="copyUnequalProperties(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyUnequalProperties(S, T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyUnequalProperties</h4> +<pre>public abstract void copyUnequalProperties(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</pre> +</li> +</ul> +<a name="copyDirtyProperties(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyDirtyProperties(S, T)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>copyDirtyProperties</h4> +<pre>public abstract void copyDirtyProperties(<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> source, + <a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> target)</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/StorableCopier.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/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableCopier.html" target="_top">Frames</a></li> +<li><a href="StorableCopier.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> diff --git a/apidocs/com/amazon/carbonado/gen/StorableGenerator.html b/apidocs/com/amazon/carbonado/gen/StorableGenerator.html new file mode 100644 index 0000000..074f949 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableGenerator.html @@ -0,0 +1,755 @@ +<!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>StorableGenerator (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="StorableGenerator (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/StorableGenerator.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/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableGenerator.html" target="_top">Frames</a></li> +<li><a href="StorableGenerator.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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.gen</div> +<h2 title="Class StorableGenerator" class="title">Class StorableGenerator<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.gen.StorableGenerator<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">StorableGenerator<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> + types. This greatly simplifies the process of defining new kinds of <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repositories</code></a>, since most of the mundane code generation is taken + care of.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Don Schneider, Tobias Holgers</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>, +<a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#ADAPTER_FIELD_ELEMENT">ADAPTER_FIELD_ELEMENT</a></strong></code> +<div class="block">Adapter field names are propertyName + "$adapter$" + number</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_DELETE_METHOD_NAME">CHECK_PK_FOR_DELETE_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_INSERT_METHOD_NAME">CHECK_PK_FOR_INSERT_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_LOAD_METHOD_NAME">CHECK_PK_FOR_LOAD_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_UPDATE_METHOD_NAME">CHECK_PK_FOR_UPDATE_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#CONSTRAINT_FIELD_ELEMENT">CONSTRAINT_FIELD_ELEMENT</a></strong></code> +<div class="block">Constraint field names are propertyName + "$constraint$" + number</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_DELETE_METHOD_NAME">DO_TRY_DELETE_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_INSERT_METHOD_NAME">DO_TRY_INSERT_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_LOAD_METHOD_NAME">DO_TRY_LOAD_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_UPDATE_METHOD_NAME">DO_TRY_UPDATE_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_ALT_KEY_INITIALIZED_PREFIX">IS_ALT_KEY_INITIALIZED_PREFIX</a></strong></code> +<div class="block">Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_PARTITION_KEY_INITIALIZED_METHOD_NAME">IS_PARTITION_KEY_INITIALIZED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable that returns false if any + partition keys are uninitialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_PK_INITIALIZED_METHOD_NAME">IS_PK_INITIALIZED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable that returns false if any + primary keys are uninitialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME">IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#IS_VERSION_INITIALIZED_METHOD_NAME">IS_VERSION_INITIALIZED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method in generated storable that returns false if + version property is uninitialized.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#LOAD_COMPLETED_METHOD_NAME">LOAD_COMPLETED_METHOD_NAME</a></strong></code> +<div class="block">Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_CLEAN">PROPERTY_STATE_CLEAN</a></strong></code> +<div class="block">Property state indicating that property value reflects a clean value</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_DIRTY">PROPERTY_STATE_DIRTY</a></strong></code> +<div class="block">Property state indicating that property has been set, but not saved</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_FIELD_NAME">PROPERTY_STATE_FIELD_NAME</a></strong></code> +<div class="block">Prefix of protected field in generated storable that holds property + states.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_MASK">PROPERTY_STATE_MASK</a></strong></code> +<div class="block">Property state mask is 3, to cover the two bits used by a property state</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_UNINITIALIZED">PROPERTY_STATE_UNINITIALIZED</a></strong></code> +<div class="block">Property state indicating that property has never been set, loaded, or saved</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#SUPPORT_FIELD_NAME">SUPPORT_FIELD_NAME</a></strong></code> +<div class="block">Reference to TriggerSupport instance</div> +</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>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html#getAbstractClass(java.lang.Class)">getAbstractClass</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DO_TRY_LOAD_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_LOAD_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_LOAD_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.DO_TRY_LOAD_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_INSERT_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_INSERT_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_INSERT_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.DO_TRY_INSERT_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_UPDATE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_UPDATE_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_UPDATE_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.DO_TRY_UPDATE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DO_TRY_DELETE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DO_TRY_DELETE_METHOD_NAME</h4> +<pre>public static final java.lang.String DO_TRY_DELETE_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.DO_TRY_DELETE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CHECK_PK_FOR_INSERT_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_PK_FOR_INSERT_METHOD_NAME</h4> +<pre>public static final java.lang.String CHECK_PK_FOR_INSERT_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CHECK_PK_FOR_INSERT_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CHECK_PK_FOR_UPDATE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_PK_FOR_UPDATE_METHOD_NAME</h4> +<pre>public static final java.lang.String CHECK_PK_FOR_UPDATE_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CHECK_PK_FOR_UPDATE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CHECK_PK_FOR_DELETE_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_PK_FOR_DELETE_METHOD_NAME</h4> +<pre>public static final java.lang.String CHECK_PK_FOR_DELETE_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CHECK_PK_FOR_DELETE_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CHECK_PK_FOR_LOAD_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CHECK_PK_FOR_LOAD_METHOD_NAME</h4> +<pre>public static final java.lang.String CHECK_PK_FOR_LOAD_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CHECK_PK_FOR_LOAD_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_PK_INITIALIZED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_PK_INITIALIZED_METHOD_NAME</h4> +<pre>public static final java.lang.String IS_PK_INITIALIZED_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable that returns false if any + primary keys are uninitialized.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_PK_INITIALIZED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_PARTITION_KEY_INITIALIZED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_PARTITION_KEY_INITIALIZED_METHOD_NAME</h4> +<pre>public static final java.lang.String IS_PARTITION_KEY_INITIALIZED_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable that returns false if any + partition keys are uninitialized.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_PARTITION_KEY_INITIALIZED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_ALT_KEY_INITIALIZED_PREFIX"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_ALT_KEY_INITIALIZED_PREFIX</h4> +<pre>public static final java.lang.String IS_ALT_KEY_INITIALIZED_PREFIX</pre> +<div class="block">Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized. The complete name is + formed by the prefix appended with the zero-based alternate key number.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_ALT_KEY_INITIALIZED_PREFIX">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME</h4> +<pre>public static final java.lang.String IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="IS_VERSION_INITIALIZED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IS_VERSION_INITIALIZED_METHOD_NAME</h4> +<pre>public static final java.lang.String IS_VERSION_INITIALIZED_METHOD_NAME</pre> +<div class="block">Name of protected method in generated storable that returns false if + version property is uninitialized. If no version property exists, then + this method is not defined.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.IS_VERSION_INITIALIZED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="LOAD_COMPLETED_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOAD_COMPLETED_METHOD_NAME</h4> +<pre>public static final java.lang.String LOAD_COMPLETED_METHOD_NAME</pre> +<div class="block">Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.LOAD_COMPLETED_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_FIELD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_STATE_FIELD_NAME</h4> +<pre>public static final java.lang.String PROPERTY_STATE_FIELD_NAME</pre> +<div class="block">Prefix of protected field in generated storable that holds property + states. Each property consumes two bits to hold its state, and so each + 32-bit field holds states for up to 16 properties.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_FIELD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ADAPTER_FIELD_ELEMENT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ADAPTER_FIELD_ELEMENT</h4> +<pre>public static final java.lang.String ADAPTER_FIELD_ELEMENT</pre> +<div class="block">Adapter field names are propertyName + "$adapter$" + number</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.ADAPTER_FIELD_ELEMENT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CONSTRAINT_FIELD_ELEMENT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONSTRAINT_FIELD_ELEMENT</h4> +<pre>public static final java.lang.String CONSTRAINT_FIELD_ELEMENT</pre> +<div class="block">Constraint field names are propertyName + "$constraint$" + number</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.CONSTRAINT_FIELD_ELEMENT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="SUPPORT_FIELD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SUPPORT_FIELD_NAME</h4> +<pre>public static final java.lang.String SUPPORT_FIELD_NAME</pre> +<div class="block">Reference to TriggerSupport instance</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.SUPPORT_FIELD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_UNINITIALIZED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_STATE_UNINITIALIZED</h4> +<pre>public static final int PROPERTY_STATE_UNINITIALIZED</pre> +<div class="block">Property state indicating that property has never been set, loaded, or saved</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_UNINITIALIZED">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_DIRTY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_STATE_DIRTY</h4> +<pre>public static final int PROPERTY_STATE_DIRTY</pre> +<div class="block">Property state indicating that property has been set, but not saved</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_DIRTY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_CLEAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PROPERTY_STATE_CLEAN</h4> +<pre>public static final int PROPERTY_STATE_CLEAN</pre> +<div class="block">Property state indicating that property value reflects a clean value</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_CLEAN">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PROPERTY_STATE_MASK"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PROPERTY_STATE_MASK</h4> +<pre>public static final int PROPERTY_STATE_MASK</pre> +<div class="block">Property state mask is 3, to cover the two bits used by a property state</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.gen.StorableGenerator.PROPERTY_STATE_MASK">Constant Field Values</a></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="getAbstractClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAbstractClass</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe. The Storable type itself may be an interface or a + class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. The constructor signature for the returned + abstract class is defined as follows: + + <pre> + /** + * @param support Access to triggers + */ + public <init>(TriggerSupport support); + </pre> + + <p>Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + <pre> + // Load the object by examining the primary key. + protected abstract boolean doTryLoad() throws FetchException; + + // Insert the object into the storage layer. + protected abstract boolean doTryInsert() throws PersistException; + + // Update the object in the storage. + protected abstract boolean doTryUpdate() throws PersistException; + + // Delete the object from the storage layer by the primary key. + protected abstract boolean doTryDelete() throws PersistException; + </pre> + + A set of protected hook methods are provided which ensure that all + primary keys are initialized before performing a repository + operation. Subclasses may override them, if they are capable of filling + in unspecified primary keys. One such example is applying a sequence on + insert. + + <pre> + // Throws exception if any primary keys are uninitialized. + // Actual method name defined by CHECK_PK_FOR_INSERT_METHOD_NAME. + protected void checkPkForInsert() throws IllegalStateException; + + // Throws exception if any primary keys are uninitialized. + // Actual method name defined by CHECK_PK_FOR_UPDATE_METHOD_NAME. + protected void checkPkForUpdate() throws IllegalStateException; + + // Throws exception if any primary keys are uninitialized. + // Actual method name defined by CHECK_PK_FOR_DELETE_METHOD_NAME. + protected void checkPkForDelete() throws IllegalStateException; + </pre> + + Each property value is defined as a protected field whose name and type + matches the property. Subclasses should access these fields directly + during loading and storing. For loading, it bypasses constraint + checks. For both, it provides better performance. + + <p>Subclasses also have access to a set of property state bits stored + in protected int fields. Subclasses are not responsible for updating + these values. The intention is that these states may be used by + subclasses to support partial updates. They may otherwise be ignored. + + <p>As a convenience, protected methods are provided to test and alter + the property state bits. Subclass constructors that fill all properties + with loaded values must call loadCompleted to ensure all properties are + identified as being valid and to fire any load triggers. + + <pre> + // Returns true if all primary key properties have been set. + protected boolean isPkInitialized(); + + // Returns true if all partition key properties have been set. + protected boolean isPartitionKeyInitialized(); + + // Returns true if all required data properties are set. + // A required data property is a non-nullable, non-primary key. + protected boolean isRequiredDataInitialized(); + + // Returns true if a version property has been set. + // Note: This method is not generated if there is no version property. + protected boolean isVersionInitialized(); + + // Must be called after load to identify all properties as valid + // and to fire any load triggers. + // Actual method name defined by LOAD_COMPLETED_METHOD_NAME. + protected void loadCompleted() throws FetchException; + </pre> + + Property state field names are defined by the concatenation of + <code>PROPERTY_STATE_FIELD_NAME</code> and a zero-based decimal + number. To determine which field holds a particular property's state, + the field number is computed as the property number divided by 16. The + specific two-bit state position is the remainder of this division times 2.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if Storable type is not well-formed</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</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/StorableGenerator.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/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableGenerator.html" target="_top">Frames</a></li> +<li><a href="StorableGenerator.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html b/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html new file mode 100644 index 0000000..8c78feb --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorablePropertyMap.html @@ -0,0 +1,461 @@ +<!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>StorablePropertyMap (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="StorablePropertyMap (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/StorablePropertyMap.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/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorablePropertyMap.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyMap.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_classes_inherited_from_class_java.util.AbstractMap">Nested</a> | </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.gen</div> +<h2 title="Class StorablePropertyMap" class="title">Class StorablePropertyMap<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>java.util.AbstractMap<java.lang.String,java.lang.Object></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.gen.StorablePropertyMap<S></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.Map<java.lang.String,java.lang.Object></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyMap<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.util.AbstractMap<java.lang.String,java.lang.Object></pre> +<div class="block">Basic implementation for <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()"><code>Storable.propertyMap()</code></a> method.</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_java.util.AbstractMap"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class java.util.AbstractMap</h3> +<code>java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_java.util.Map"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface java.util.Map</h3> +<code>java.util.Map.Entry<K,V></code></li> +</ul> +</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#clear()">clear</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#containsKey(java.lang.Object)">containsKey</a></strong>(java.lang.Object key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#createMap(java.lang.Class, S)">createMap</a></strong>(java.lang.Class<S> type, + S storable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#entrySet()">entrySet</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#get(java.lang.Object)">get</a></strong>(java.lang.Object key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#isEmpty()">isEmpty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#keySet()">keySet</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#put(java.lang.String, java.lang.Object)">put</a></strong>(java.lang.String key, + java.lang.Object value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#size()">size</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Collection<java.lang.Object></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#values()">values</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractMap"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractMap</h3> +<code>clone, containsValue, equals, hashCode, putAll, toString</code></li> +</ul> +<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>finalize, getClass, notify, notifyAll, wait, wait, wait</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="createMap(java.lang.Class,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="createMap(java.lang.Class, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createMap</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a><S> createMap(java.lang.Class<S> type, + S storable)</pre> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>size</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>isEmpty</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>isEmpty</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="containsKey(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsKey</h4> +<pre>public boolean containsKey(java.lang.Object key)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>containsKey</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>containsKey</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="get(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public java.lang.Object get(java.lang.Object key)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>get</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>get</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="put(java.lang.String, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public java.lang.Object put(java.lang.String key, + java.lang.Object value)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>put</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>put</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="remove(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public java.lang.Object remove(java.lang.Object key)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>remove</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>remove</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>clear</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>clear</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="keySet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keySet</h4> +<pre>public java.util.Set<java.lang.String> keySet()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>keySet</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>keySet</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public java.util.Collection<java.lang.Object> values()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>values</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>values</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></code></dd> +</dl> +</li> +</ul> +<a name="entrySet()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>entrySet</h4> +<pre>public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>entrySet</code> in interface <code>java.util.Map<java.lang.String,java.lang.Object></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>entrySet</code> in class <code>java.util.AbstractMap<java.lang.String,java.lang.Object></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/StorablePropertyMap.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/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorablePropertyMap.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyMap.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_classes_inherited_from_class_java.util.AbstractMap">Nested</a> | </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> diff --git a/apidocs/com/amazon/carbonado/gen/StorableSupport.html b/apidocs/com/amazon/carbonado/gen/StorableSupport.html new file mode 100644 index 0000000..5ba4940 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/StorableSupport.html @@ -0,0 +1,237 @@ +<!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>StorableSupport (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="StorableSupport (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/StorableSupport.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/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableSupport.html" target="_top">Frames</a></li> +<li><a href="StorableSupport.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.gen</div> +<h2 title="Interface StorableSupport" class="title">Interface StorableSupport<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 Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a><S>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S>, <a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S>, <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</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">StorableSupport<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html#getRootRepository()">getRootRepository</a></strong>()</code> +<div class="block">Returns the root parent Repository that the Storable came from.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html#isPropertySupported(java.lang.String)">isPropertySupported</a></strong>(java.lang.String propertyName)</code> +<div class="block">Returns true if the given property exists and is supported.</div> +</td> +</tr> +</table> +</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="getRootRepository()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRootRepository</h4> +<pre><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> getRootRepository()</pre> +<div class="block">Returns the root parent Repository that the Storable came from.</div> +</li> +</ul> +<a name="isPropertySupported(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isPropertySupported</h4> +<pre>boolean isPropertySupported(java.lang.String propertyName)</pre> +<div class="block">Returns true if the given property exists and is supported.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to check</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/StorableSupport.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/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/StorableSupport.html" target="_top">Frames</a></li> +<li><a href="StorableSupport.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> diff --git a/apidocs/com/amazon/carbonado/gen/TriggerSupport.html b/apidocs/com/amazon/carbonado/gen/TriggerSupport.html new file mode 100644 index 0000000..6664e02 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/TriggerSupport.html @@ -0,0 +1,326 @@ +<!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>TriggerSupport (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="TriggerSupport (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/TriggerSupport.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/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/TriggerSupport.html" target="_top">Frames</a></li> +<li><a href="TriggerSupport.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.gen</div> +<h2 title="Interface TriggerSupport" class="title">Interface TriggerSupport<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/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a><S></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a><S>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S>, <a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S>, <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">TriggerSupport<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/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a><S></pre> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getDeleteTrigger()">getDeleteTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all delete operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getInsertTrigger()">getInsertTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all insert operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getLoadTrigger()">getLoadTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all load and fetch operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#getUpdateTrigger()">getUpdateTrigger</a></strong>()</code> +<div class="block">Returns a trigger which must be run for all update operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#locallyDisableLoadTrigger()">locallyDisableLoadTrigger</a></strong>()</code> +<div class="block">Disables execution of load trigger for the current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html#locallyEnableLoadTrigger()">locallyEnableLoadTrigger</a></strong>()</code> +<div class="block">Enables execution of load trigger for the current thread, if they it + been disabled before.</div> +</td> +</tr> +</table> +<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="getInsertTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInsertTrigger</h4> +<pre><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>> getInsertTrigger()</pre> +<div class="block">Returns a trigger which must be run for all insert operations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no trigger</dd></dl> +</li> +</ul> +<a name="getUpdateTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUpdateTrigger</h4> +<pre><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>> getUpdateTrigger()</pre> +<div class="block">Returns a trigger which must be run for all update operations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no trigger</dd></dl> +</li> +</ul> +<a name="getDeleteTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeleteTrigger</h4> +<pre><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>> getDeleteTrigger()</pre> +<div class="block">Returns a trigger which must be run for all delete operations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no trigger</dd></dl> +</li> +</ul> +<a name="getLoadTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoadTrigger</h4> +<pre><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a>> getLoadTrigger()</pre> +<div class="block">Returns a trigger which must be run for all load and fetch operations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if no trigger</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyDisableLoadTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableLoadTrigger</h4> +<pre>void locallyDisableLoadTrigger()</pre> +<div class="block">Disables execution of load trigger for the current thread. Call + locallyEnableLoadTrigger to enable again. This call can be made multiple + times, but be sure to call locallyEnableLoadTrigger the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableLoadTrigger()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>locallyEnableLoadTrigger</h4> +<pre>void locallyEnableLoadTrigger()</pre> +<div class="block">Enables execution of load trigger for the current thread, if they it + been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</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/TriggerSupport.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/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/TriggerSupport.html" target="_top">Frames</a></li> +<li><a href="TriggerSupport.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html b/apidocs/com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html new file mode 100644 index 0000000..3a72b62 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.CodeBuilderUtil (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="Uses of Class com.amazon.carbonado.gen.CodeBuilderUtil (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><a href="../../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html" target="_top">Frames</a></li> +<li><a href="CodeBuilderUtil.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.CodeBuilderUtil" class="title">Uses of Class<br>com.amazon.carbonado.gen.CodeBuilderUtil</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.gen.CodeBuilderUtil</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/CodeBuilderUtil.html" target="_top">Frames</a></li> +<li><a href="CodeBuilderUtil.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/CommonMethodNames.html b/apidocs/com/amazon/carbonado/gen/class-use/CommonMethodNames.html new file mode 100644 index 0000000..7e6acdd --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/CommonMethodNames.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.CommonMethodNames (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="Uses of Class com.amazon.carbonado.gen.CommonMethodNames (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><a href="../../../../../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/CommonMethodNames.html" target="_top">Frames</a></li> +<li><a href="CommonMethodNames.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.CommonMethodNames" class="title">Uses of Class<br>com.amazon.carbonado.gen.CommonMethodNames</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.gen.CommonMethodNames</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/CommonMethodNames.html" target="_top">Frames</a></li> +<li><a href="CommonMethodNames.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html new file mode 100644 index 0000000..0f82f55 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.DelegateStorableGenerator (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="Uses of Class com.amazon.carbonado.gen.DelegateStorableGenerator (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><a href="../../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="DelegateStorableGenerator.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.DelegateStorableGenerator" class="title">Uses of Class<br>com.amazon.carbonado.gen.DelegateStorableGenerator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.gen.DelegateStorableGenerator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/DelegateStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="DelegateStorableGenerator.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/DelegateSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/DelegateSupport.html new file mode 100644 index 0000000..cdf1a8f --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/DelegateSupport.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.gen.DelegateSupport (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="Uses of Interface com.amazon.carbonado.gen.DelegateSupport (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><a href="../../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/DelegateSupport.html" target="_top">Frames</a></li> +<li><a href="DelegateSupport.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"> +<h2 title="Uses of Interface com.amazon.carbonado.gen.DelegateSupport" class="title">Uses of Interface<br>com.amazon.carbonado.gen.DelegateSupport</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.gen.DelegateSupport</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/DelegateSupport.html" target="_top">Frames</a></li> +<li><a href="DelegateSupport.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html b/apidocs/com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html new file mode 100644 index 0000000..f110ac0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.DetachedStorableFactory (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="Uses of Class com.amazon.carbonado.gen.DetachedStorableFactory (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><a href="../../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html" target="_top">Frames</a></li> +<li><a href="DetachedStorableFactory.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.DetachedStorableFactory" class="title">Uses of Class<br>com.amazon.carbonado.gen.DetachedStorableFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.gen.DetachedStorableFactory</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/DetachedStorableFactory.html" target="_top">Frames</a></li> +<li><a href="DetachedStorableFactory.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/MasterFeature.html b/apidocs/com/amazon/carbonado/gen/class-use/MasterFeature.html new file mode 100644 index 0000000..bac4cdf --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/MasterFeature.html @@ -0,0 +1,193 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.MasterFeature (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="Uses of Class com.amazon.carbonado.gen.MasterFeature (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><a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/MasterFeature.html" target="_top">Frames</a></li> +<li><a href="MasterFeature.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.MasterFeature" class="title">Uses of Class<br>com.amazon.carbonado.gen.MasterFeature</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that return <a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a></code></td> +<td class="colLast"><span class="strong">MasterFeature.</span><code><strong><a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>[]</code></td> +<td class="colLast"><span class="strong">MasterFeature.</span><code><strong><a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> with type arguments of type <a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">MasterStorableGenerator.</span><code><strong><a href="../../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html#getAbstractClass(java.lang.Class, java.util.EnumSet)">getAbstractClass</a></strong>(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which + is fully thread-safe.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><span class="strong">DelegateStorableGenerator.</span><code><strong><a href="../../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html#getDelegateClass(java.lang.Class, java.util.EnumSet)">getDelegateClass</a></strong>(java.lang.Class<S> type, + java.util.EnumSet<<a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a>> features)</code> +<div class="block">Delegate class has a constructor that accepts a <a href="../../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a> + instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/MasterFeature.html" target="_top">Frames</a></li> +<li><a href="MasterFeature.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html b/apidocs/com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html new file mode 100644 index 0000000..1bb172c --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.MasterStorableGenerator (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="Uses of Class com.amazon.carbonado.gen.MasterStorableGenerator (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><a href="../../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="MasterStorableGenerator.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.MasterStorableGenerator" class="title">Uses of Class<br>com.amazon.carbonado.gen.MasterStorableGenerator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.gen.MasterStorableGenerator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/MasterStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="MasterStorableGenerator.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/MasterSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/MasterSupport.html new file mode 100644 index 0000000..cff74da --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/MasterSupport.html @@ -0,0 +1,213 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.gen.MasterSupport (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="Uses of Interface com.amazon.carbonado.gen.MasterSupport (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><a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/MasterSupport.html" target="_top">Frames</a></li> +<li><a href="MasterSupport.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"> +<h2 title="Uses of Interface com.amazon.carbonado.gen.MasterSupport" class="title">Uses of Interface<br>com.amazon.carbonado.gen.MasterSupport</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<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> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/MasterSupport.html" target="_top">Frames</a></li> +<li><a href="MasterSupport.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html new file mode 100644 index 0000000..b5f4a8d --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.From.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.StorableCopier.From (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="Uses of Class com.amazon.carbonado.gen.StorableCopier.From (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><a href="../../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorableCopier.From.html" target="_top">Frames</a></li> +<li><a href="StorableCopier.From.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.StorableCopier.From" class="title">Uses of Class<br>com.amazon.carbonado.gen.StorableCopier.From</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that return <a href="../../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a><S></code></td> +<td class="colLast"><span class="strong">StorableCopier.</span><code><strong><a href="../../../../../com/amazon/carbonado/gen/StorableCopier.html#from(java.lang.Class)">from</a></strong>(java.lang.Class<S> source)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorableCopier.From.html" target="_top">Frames</a></li> +<li><a href="StorableCopier.From.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html new file mode 100644 index 0000000..6c69b53 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableCopier.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.StorableCopier (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="Uses of Class com.amazon.carbonado.gen.StorableCopier (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><a href="../../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorableCopier.html" target="_top">Frames</a></li> +<li><a href="StorableCopier.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.StorableCopier" class="title">Uses of Class<br>com.amazon.carbonado.gen.StorableCopier</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that return <a href="../../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a><<a href="../../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="type parameter in StorableCopier.From">S</a>,T></code></td> +<td class="colLast"><span class="strong">StorableCopier.From.</span><code><strong><a href="../../../../../com/amazon/carbonado/gen/StorableCopier.From.html#to(java.lang.Class)">to</a></strong>(java.lang.Class<T> target)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorableCopier.html" target="_top">Frames</a></li> +<li><a href="StorableCopier.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableGenerator.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableGenerator.html new file mode 100644 index 0000000..62af1d6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableGenerator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.StorableGenerator (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="Uses of Class com.amazon.carbonado.gen.StorableGenerator (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><a href="../../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorableGenerator.html" target="_top">Frames</a></li> +<li><a href="StorableGenerator.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.StorableGenerator" class="title">Uses of Class<br>com.amazon.carbonado.gen.StorableGenerator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.gen.StorableGenerator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorableGenerator.html" target="_top">Frames</a></li> +<li><a href="StorableGenerator.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html b/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html new file mode 100644 index 0000000..6b5be53 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorablePropertyMap.html @@ -0,0 +1,160 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.gen.StorablePropertyMap (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="Uses of Class com.amazon.carbonado.gen.StorablePropertyMap (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><a href="../../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorablePropertyMap.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyMap.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"> +<h2 title="Uses of Class com.amazon.carbonado.gen.StorablePropertyMap" class="title">Uses of Class<br>com.amazon.carbonado.gen.StorablePropertyMap</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that return <a href="../../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a><S></code></td> +<td class="colLast"><span class="strong">StorablePropertyMap.</span><code><strong><a href="../../../../../com/amazon/carbonado/gen/StorablePropertyMap.html#createMap(java.lang.Class, S)">createMap</a></strong>(java.lang.Class<S> type, + S storable)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorablePropertyMap.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyMap.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html new file mode 100644 index 0000000..53be458 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/StorableSupport.html @@ -0,0 +1,225 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.gen.StorableSupport (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="Uses of Interface com.amazon.carbonado.gen.StorableSupport (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><a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorableSupport.html" target="_top">Frames</a></li> +<li><a href="StorableSupport.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"> +<h2 title="Uses of Interface com.amazon.carbonado.gen.StorableSupport" class="title">Uses of Interface<br>com.amazon.carbonado.gen.StorableSupport</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<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> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/StorableSupport.html" target="_top">Frames</a></li> +<li><a href="StorableSupport.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> diff --git a/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html b/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html new file mode 100644 index 0000000..62d1c01 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/class-use/TriggerSupport.html @@ -0,0 +1,219 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.gen.TriggerSupport (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="Uses of Interface com.amazon.carbonado.gen.TriggerSupport (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><a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/TriggerSupport.html" target="_top">Frames</a></li> +<li><a href="TriggerSupport.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"> +<h2 title="Uses of Interface com.amazon.carbonado.gen.TriggerSupport" class="title">Uses of Interface<br>com.amazon.carbonado.gen.TriggerSupport</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<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> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/gen/class-use/TriggerSupport.html" target="_top">Frames</a></li> +<li><a href="TriggerSupport.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> diff --git a/apidocs/com/amazon/carbonado/gen/package-frame.html b/apidocs/com/amazon/carbonado/gen/package-frame.html new file mode 100644 index 0000000..2a3cb8a --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-frame.html @@ -0,0 +1,39 @@ +<!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.gen (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/gen/package-summary.html" target="classFrame">com.amazon.carbonado.gen</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="DelegateSupport.html" title="interface in com.amazon.carbonado.gen" target="classFrame"><i>DelegateSupport</i></a></li> +<li><a href="MasterSupport.html" title="interface in com.amazon.carbonado.gen" target="classFrame"><i>MasterSupport</i></a></li> +<li><a href="StorableSupport.html" title="interface in com.amazon.carbonado.gen" target="classFrame"><i>StorableSupport</i></a></li> +<li><a href="TriggerSupport.html" title="interface in com.amazon.carbonado.gen" target="classFrame"><i>TriggerSupport</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen" target="classFrame">CodeBuilderUtil</a></li> +<li><a href="CommonMethodNames.html" title="class in com.amazon.carbonado.gen" target="classFrame">CommonMethodNames</a></li> +<li><a href="DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen" target="classFrame">DelegateStorableGenerator</a></li> +<li><a href="DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen" target="classFrame">DetachedStorableFactory</a></li> +<li><a href="MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen" target="classFrame">MasterStorableGenerator</a></li> +<li><a href="StorableCopier.html" title="class in com.amazon.carbonado.gen" target="classFrame">StorableCopier</a></li> +<li><a href="StorableCopier.From.html" title="class in com.amazon.carbonado.gen" target="classFrame">StorableCopier.From</a></li> +<li><a href="StorableGenerator.html" title="class in com.amazon.carbonado.gen" target="classFrame">StorableGenerator</a></li> +<li><a href="StorablePropertyMap.html" title="class in com.amazon.carbonado.gen" target="classFrame">StorablePropertyMap</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="MasterFeature.html" title="enum in com.amazon.carbonado.gen" target="classFrame">MasterFeature</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/gen/package-summary.html b/apidocs/com/amazon/carbonado/gen/package-summary.html new file mode 100644 index 0000000..5b325cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-summary.html @@ -0,0 +1,249 @@ +<!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.gen (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.gen (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><a href="../../../../com/amazon/carbonado/filter/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/info/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/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.gen</h1> +<div class="docSummary"> +<div class="block">Storable code generation support intended for use by repository implementations.</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/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</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">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</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">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</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">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</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">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</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/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></td> +<td class="colLast"> +<div class="block">Collection of useful utilities for generating Carbonado code.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></td> +<td class="colLast"> +<div class="block">Collection of constant method names for the public API.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen">DelegateStorableGenerator</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">Generates and caches concrete implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + which delegate to <a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen">DetachedStorableFactory</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">Creates <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> instances which are basic data containers.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">MasterStorableGenerator</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">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + suitable for use by master repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Copies properties between otherwise incompatible Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</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">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> + types.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</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">Basic implementation for <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()"><code>Storable.propertyMap()</code></a> method.</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/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a></td> +<td class="colLast"> +<div class="block">Master feature to enable when using <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.gen Description">Package com.amazon.carbonado.gen Description</h2> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</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><a href="../../../../com/amazon/carbonado/filter/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/info/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/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> diff --git a/apidocs/com/amazon/carbonado/gen/package-tree.html b/apidocs/com/amazon/carbonado/gen/package-tree.html new file mode 100644 index 0000000..5a392c8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-tree.html @@ -0,0 +1,170 @@ +<!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.gen Class Hierarchy (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.gen Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/filter/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/info/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.gen</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.util.AbstractMap<K,V> (implements java.util.Map<K,V>) +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen"><span class="strong">StorablePropertyMap</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen"><span class="strong">CodeBuilderUtil</span></a></li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen"><span class="strong">CommonMethodNames</span></a></li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">DelegateStorableGenerator</span></a><S></li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen"><span class="strong">DetachedStorableFactory</span></a><S></li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">MasterStorableGenerator</span></a><S></li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen"><span class="strong">StorableCopier</span></a><S,T></li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen"><span class="strong">StorableCopier.From</span></a><S></li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">StorableGenerator</span></a><S></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">StorableSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">TriggerSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">MasterSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">DelegateSupport</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen"><span class="strong">MasterFeature</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/filter/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/info/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/gen/package-use.html b/apidocs/com/amazon/carbonado/gen/package-use.html new file mode 100644 index 0000000..64fe2be --- /dev/null +++ b/apidocs/com/amazon/carbonado/gen/package-use.html @@ -0,0 +1,250 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.gen (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="Uses of Package com.amazon.carbonado.gen (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.gen" class="title">Uses of Package<br>com.amazon.carbonado.gen</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> used by <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/MasterFeature.html#com.amazon.carbonado.gen">MasterFeature</a> +<div class="block">Master feature to enable when using <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/MasterSupport.html#com.amazon.carbonado.gen">MasterSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/StorableCopier.html#com.amazon.carbonado.gen">StorableCopier</a> +<div class="block">Copies properties between otherwise incompatible Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/StorableCopier.From.html#com.amazon.carbonado.gen">StorableCopier.From</a> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/StorablePropertyMap.html#com.amazon.carbonado.gen">StorablePropertyMap</a> +<div class="block">Basic implementation for <a href="../../../../com/amazon/carbonado/Storable.html#propertyMap()"><code>Storable.propertyMap()</code></a> method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/StorableSupport.html#com.amazon.carbonado.gen">StorableSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/TriggerSupport.html#com.amazon.carbonado.gen">TriggerSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/MasterSupport.html#com.amazon.carbonado.raw">MasterSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/StorableSupport.html#com.amazon.carbonado.raw">StorableSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/TriggerSupport.html#com.amazon.carbonado.raw">TriggerSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/MasterSupport.html#com.amazon.carbonado.repo.jdbc">MasterSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/StorableSupport.html#com.amazon.carbonado.repo.jdbc">StorableSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/gen/class-use/TriggerSupport.html#com.amazon.carbonado.repo.jdbc">TriggerSupport</a> +<div class="block">Provides runtime support for Storable classes generated by <a href="../../../../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/gen/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/info/ChainedProperty.html b/apidocs/com/amazon/carbonado/info/ChainedProperty.html new file mode 100644 index 0000000..de0ae35 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/ChainedProperty.html @@ -0,0 +1,625 @@ +<!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>ChainedProperty (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="ChainedProperty (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/ChainedProperty.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/ChainedProperty.html" target="_top">Frames</a></li> +<li><a href="ChainedProperty.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.info</div> +<h2 title="Class ChainedProperty" class="title">Class ChainedProperty<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.info.ChainedProperty<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ChainedProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements java.io.Serializable, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Represents a property to filter on or to order by. Properties may be + specified in a simple form, like "firstName", or in a chained form, like + "address.state". In both forms, the first property is the "prime" + property. All properties that follow are chained.</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="../../../../serialized-form.html#com.amazon.carbonado.info.ChainedProperty">Serialized Form</a></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><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.ChainedProperty)">append</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty)">append</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty, boolean)">append</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property, + boolean outerJoin)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Appends the chained property formatted as "name.subname.subsubname".</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</code> +<div class="block">Returns a canonical instance which has no chain.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getChainCount()">getChainCount</a></strong>()</code> +<div class="block">Returns amount of properties chained from prime property, which may be + zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getChainedProperty(int)">getChainedProperty</a></strong>(int index)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getLastProperty()">getLastProperty</a></strong>()</code> +<div class="block">Returns the last property in the chain, or the prime property if chain + is empty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getPrimeProperty()">getPrimeProperty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getType()">getType</a></strong>()</code> +<div class="block">Returns the type of the last property in the chain, or of the prime + property if the chain is empty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#isDerived()">isDerived</a></strong>()</code> +<div class="block">Returns true if any property in the chain is derived.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#isNullable()">isNullable</a></strong>()</code> +<div class="block">Returns true if any property in the chain can be null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#isOuterJoin(int)">isOuterJoin</a></strong>(int index)</code> +<div class="block">Returns true if the property at the given index should be treated as an + outer join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses a chained property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#tail()">tail</a></strong>()</code> +<div class="block">Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.</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/info/ChainedProperty.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the chained property formatted as "name.subname.subsubname".</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#trim()">trim</a></strong>()</code> +<div class="block">Returns a new ChainedProperty with the last property in the chain removed.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="get(com.amazon.carbonado.info.StorableProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</pre> +<div class="block">Returns a canonical instance which has no chain.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if prime is null</dd></dl> +</li> +</ul> +<a name="get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</pre> +<div class="block">Returns a canonical instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if prime is null or if chained + properties are not formed properly</dd></dl> +</li> +</ul> +<a name="get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</pre> +<div class="block">Returns a canonical instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if prime is null or if chained + properties are not formed properly</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> parse(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Parses a chained property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - Info for Storable type containing property</dd><dd><code>str</code> - string to parse</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null or string + format is incorrect</dd></dl> +</li> +</ul> +<a name="getPrimeProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimeProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> getPrimeProperty()</pre> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public java.lang.Class<?> getType()</pre> +<div class="block">Returns the type of the last property in the chain, or of the prime + property if the chain is empty.</div> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>public boolean isNullable()</pre> +<div class="block">Returns true if any property in the chain can be null.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><code>Nullable</code></a></dd></dl> +</li> +</ul> +<a name="isDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDerived</h4> +<pre>public boolean isDerived()</pre> +<div class="block">Returns true if any property in the chain is derived.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><code>Derived</code></a></dd></dl> +</li> +</ul> +<a name="getLastProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> getLastProperty()</pre> +<div class="block">Returns the last property in the chain, or the prime property if chain + is empty.</div> +</li> +</ul> +<a name="getChainCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChainCount</h4> +<pre>public int getChainCount()</pre> +<div class="block">Returns amount of properties chained from prime property, which may be + zero.</div> +</li> +</ul> +<a name="getChainedProperty(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChainedProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> getChainedProperty(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - valid range is 0 to chainCount - 1</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="isOuterJoin(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOuterJoin</h4> +<pre>public boolean isOuterJoin(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns true if the property at the given index should be treated as an + outer join. Index zero is the prime property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - valid range is 0 to chainCount</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="append(com.amazon.carbonado.info.StorableProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> append(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property)</pre> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</li> +</ul> +<a name="append(com.amazon.carbonado.info.StorableProperty, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> append(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property, + boolean outerJoin)</pre> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outerJoin</code> - pass true for outer join</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="append(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> append(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> property)</pre> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</li> +</ul> +<a name="trim()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>trim</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> trim()</pre> +<div class="block">Returns a new ChainedProperty with the last property in the chain removed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if chain count is zero</dd></dl> +</li> +</ul> +<a name="tail()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tail</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> tail()</pre> +<div class="block">Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if chain count is zero</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns the chained property formatted as "name.subname.subsubname". + This format is parseable only if the chain is composed of valid + many-to-one joins.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Appends the chained property formatted as "name.subname.subsubname". + This format is parseable only if the chain is composed of valid + many-to-one joins.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</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/ChainedProperty.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/ChainedProperty.html" target="_top">Frames</a></li> +<li><a href="ChainedProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/Direction.html b/apidocs/com/amazon/carbonado/info/Direction.html new file mode 100644 index 0000000..b1e7db0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/Direction.html @@ -0,0 +1,388 @@ +<!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>Direction (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="Direction (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/Direction.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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/Direction.html" target="_top">Frames</a></li> +<li><a href="Direction.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.info</div> +<h2 title="Enum Direction" class="title">Enum Direction</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.Direction</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">Direction</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>></pre> +<div class="block">Describes a property sorting direction.</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"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#ASCENDING">ASCENDING</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#DESCENDING">DESCENDING</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#UNSPECIFIED">UNSPECIFIED</a></strong></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>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#fromCharacter(char)">fromCharacter</a></strong>(char c)</code> +<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#reverse()">reverse</a></strong>()</code> +<div class="block">Returns the reverse direction of this.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#toCharacter()">toCharacter</a></strong>()</code> +<div class="block">Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="ASCENDING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ASCENDING</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> ASCENDING</pre> +</li> +</ul> +<a name="DESCENDING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DESCENDING</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> DESCENDING</pre> +</li> +</ul> +<a name="UNSPECIFIED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UNSPECIFIED</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> UNSPECIFIED</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (Direction c : Direction.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="reverse()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reverse</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> reverse()</pre> +<div class="block">Returns the reverse direction of this.</div> +</li> +</ul> +<a name="toCharacter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toCharacter</h4> +<pre>public char toCharacter()</pre> +<div class="block">Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.</div> +</li> +</ul> +<a name="fromCharacter(char)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fromCharacter</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> fromCharacter(char c)</pre> +<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.</div> +</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/Direction.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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/Direction.html" target="_top">Frames</a></li> +<li><a href="Direction.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/info/OrderedProperty.html b/apidocs/com/amazon/carbonado/info/OrderedProperty.html new file mode 100644 index 0000000..48833a5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/OrderedProperty.html @@ -0,0 +1,444 @@ +<!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>OrderedProperty (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="OrderedProperty (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/OrderedProperty.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/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/OrderedProperty.html" target="_top">Frames</a></li> +<li><a href="OrderedProperty.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.info</div> +<h2 title="Class OrderedProperty" class="title">Class OrderedProperty<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.info.OrderedProperty<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">OrderedProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements java.io.Serializable, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Represents a property paired with a preferred ordering direction.</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="../../../../serialized-form.html#com.amazon.carbonado.info.OrderedProperty">Serialized Form</a></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/info/OrderedProperty.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Append the string representation of this object to the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#direction(com.amazon.carbonado.info.Direction)">direction</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#getChainedProperty()">getChainedProperty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#getDirection()">getDirection</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#reverse()">reverse</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the chained property in a parseable form.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Returns a canonical instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is null</dd></dl> +</li> +</ul> +<a name="get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Returns a canonical instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is null</dd></dl> +</li> +</ul> +<a name="parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S> parse(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction. Prefix of '~' indicates unspecified direction. If + ordering prefix not specified, default direction is ascending.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - Info for Storable type containing property</dd><dd><code>str</code> - string to parse</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any required parameter is null or + string format is incorrect</dd></dl> +</li> +</ul> +<a name="parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S> parse(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction. Prefix of '~' indicates unspecified direction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - Info for Storable type containing property</dd><dd><code>str</code> - string to parse</dd><dd><code>defaultDirection</code> - default direction if not specified in + string. If null, ascending order is defaulted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any required parameter is null or + string format is incorrect</dd></dl> +</li> +</ul> +<a name="getChainedProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChainedProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>> getChainedProperty()</pre> +</li> +</ul> +<a name="getDirection()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDirection</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> getDirection()</pre> +</li> +</ul> +<a name="reverse()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reverse</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>> reverse()</pre> +</li> +</ul> +<a name="direction(com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>direction</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>> direction(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns the chained property in a parseable form.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">Appender</a></code></strong></div> +<div class="block">Append the string representation of this object to the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</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/OrderedProperty.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/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/OrderedProperty.html" target="_top">Frames</a></li> +<li><a href="OrderedProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/StorableIndex.html b/apidocs/com/amazon/carbonado/info/StorableIndex.html new file mode 100644 index 0000000..863b3bf --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableIndex.html @@ -0,0 +1,791 @@ +<!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>StorableIndex (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="StorableIndex (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/StorableIndex.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/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableIndex.html" target="_top">Frames</a></li> +<li><a href="StorableIndex.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><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.info</div> +<h2 title="Class StorableIndex" class="title">Class StorableIndex<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.info.StorableIndex<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorableIndex<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</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/Index.html" title="annotation in com.amazon.carbonado"><code>Index</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/info/StorableIndex.html#StorableIndex(java.lang.Class, com.amazon.carbonado.capability.IndexInfo)">StorableIndex</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> type, + <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> indexInfo)</code> +<div class="block">Creates a StorableIndex from an IndexInfo.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique, + boolean clustered)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex with the given property added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Appends the same results as toString, but without the "StorableIndex" + prefix.</div> +</td> +</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#clustered(boolean)">clustered</a></strong>(boolean clustered)</code> +<div class="block">Returns a StorableIndex instance which is clustered or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getNameDescriptor()">getNameDescriptor</a></strong>()</code> +<div class="block">Converts this index into a parseable name descriptor string, whose + general format is:</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperties()">getOrderedProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties in it, with directions + folded in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperty(int)">getOrderedProperty</a></strong>(int index)</code> +<div class="block">Returns a specific property in this index, with the direction folded in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getProperty(int)">getProperty</a></strong>(int index)</code> +<div class="block">Returns a specific property in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyCount()">getPropertyCount</a></strong>()</code> +<div class="block">Returns the count of properties in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirection(int)">getPropertyDirection</a></strong>(int index)</code> +<div class="block">Returns the requested direction of a specific property in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns a new array with all the property directions in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the type of storable this index applies to.</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/info/StorableIndex.html#getTypeDescriptor()">getTypeDescriptor</a></strong>()</code> +<div class="block">Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#isClustered()">isClustered</a></strong>()</code> +<div class="block">Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#isUnique()">isUnique</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)">parseNameDescriptor</a></strong>(java.lang.String desc, + <a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info)</code> +<div class="block">Parses an index descriptor and returns an index object.</div> +</td> +</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#reverse()">reverse</a></strong>()</code> +<div class="block">Returns a StorableIndex instance with all the properties reversed.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction.</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/info/StorableIndex.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#unique(boolean)">unique</a></strong>(boolean unique)</code> +<div class="block">Returns a StorableIndex instance which is unique or not.</div> +</td> +</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key)</code> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions)</pre> +<div class="block">Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null, if lengths + do not match, or if any length is zero.</dd></dl> +</li> +</ul> +<a name="StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique)</pre> +<div class="block">Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length. Allows specification of the + uniqueness of the index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - </dd><dd><code>directions</code> - </dd><dd><code>unique</code> - </dd></dl> +</li> +</ul> +<a name="StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique, + boolean clustered)</pre> +<div class="block">Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length. Allows specification of the + uniqueness of the index as well as clustered option.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - </dd><dd><code>directions</code> - </dd><dd><code>unique</code> - </dd><dd><code>clustered</code> - </dd></dl> +</li> +</ul> +<a name="StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>direction</code> - optional direction to apply to each key property that + has an unspecified direction</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if key is null or it has + no properties</dd></dl> +</li> +</ul> +<a name="StorableIndex(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>direction</code> - optional direction to apply to each property that + has an unspecified direction</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if no properties supplied</dd></dl> +</li> +</ul> +<a name="StorableIndex(java.lang.Class, com.amazon.carbonado.capability.IndexInfo)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> type, + <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> indexInfo)</pre> +<div class="block">Creates a StorableIndex from an IndexInfo.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable index is defined for</dd><dd><code>indexInfo</code> - IndexInfo returned from storage object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null, if any + properties are invalid, or if index info has no properties</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="parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parseNameDescriptor</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> parseNameDescriptor(java.lang.String desc, + <a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Parses an index descriptor and returns an index object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desc</code> - name descriptor, as created by <a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getNameDescriptor()"><code>getNameDescriptor()</code></a></dd><dd><code>info</code> - info on storable type</dd> +<dt><span class="strong">Returns:</span></dt><dd>index represented by descriptor</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if error in descriptor syntax or if it + refers to unknown properties</dd></dl> +</li> +</ul> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>public java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> getStorableType()</pre> +<div class="block">Returns the type of storable this index applies to.</div> +</li> +</ul> +<a name="getPropertyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyCount</h4> +<pre>public int getPropertyCount()</pre> +<div class="block">Returns the count of properties in this index.</div> +</li> +</ul> +<a name="getProperty(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> getProperty(int index)</pre> +<div class="block">Returns a specific property in this index.</div> +</li> +</ul> +<a name="getProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] getProperties()</pre> +<div class="block">Returns a new array with all the properties in it.</div> +</li> +</ul> +<a name="getPropertyDirection(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyDirection</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> getPropertyDirection(int index)</pre> +<div class="block">Returns the requested direction of a specific property in this index.</div> +</li> +</ul> +<a name="getPropertyDirections()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyDirections</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] getPropertyDirections()</pre> +<div class="block">Returns a new array with all the property directions in it.</div> +</li> +</ul> +<a name="getOrderedProperty(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrderedProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> getOrderedProperty(int index)</pre> +<div class="block">Returns a specific property in this index, with the direction folded in.</div> +</li> +</ul> +<a name="getOrderedProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrderedProperties</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] getOrderedProperties()</pre> +<div class="block">Returns a new array with all the properties in it, with directions + folded in.</div> +</li> +</ul> +<a name="isUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUnique</h4> +<pre>public boolean isUnique()</pre> +</li> +</ul> +<a name="isClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClustered</h4> +<pre>public boolean isClustered()</pre> +<div class="block">Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.</div> +</li> +</ul> +<a name="unique(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unique</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> unique(boolean unique)</pre> +<div class="block">Returns a StorableIndex instance which is unique or not.</div> +</li> +</ul> +<a name="clustered(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clustered</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> clustered(boolean clustered)</pre> +<div class="block">Returns a StorableIndex instance which is clustered or not.</div> +</li> +</ul> +<a name="reverse()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reverse</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> reverse()</pre> +<div class="block">Returns a StorableIndex instance with all the properties reversed.</div> +</li> +</ul> +<a name="setDefaultDirection(com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultDirection</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> setDefaultDirection(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction. Returns this if all directions are already + specified.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>direction</code> - direction to replace all unspecified directions</dd></dl> +</li> +</ul> +<a name="addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> addProperty(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Returns a StorableIndex with the given property added. If this index + already contained the given property (regardless of sort direction), + this index is returned.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - property to add unless already in this index</dd><dd><code>direction</code> - direction to apply to property, if added</dd> +<dt><span class="strong">Returns:</span></dt><dd>new index with added property or this if index already contained property</dd></dl> +</li> +</ul> +<a name="uniquify(com.amazon.carbonado.info.StorableKey)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>uniquify</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> uniquify(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key)</pre> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key. If index is already unique, it is + returned as-is.</div> +</li> +</ul> +<a name="getNameDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNameDescriptor</h4> +<pre>public java.lang.String getNameDescriptor()</pre> +<div class="block">Converts this index into a parseable name descriptor string, whose + general format is: + + <p><code><storable type>~<attr><+|-|~><property><+|-|~><property>...</code> + + <p>Attr is "U" for a unique index, "N" for a non-unique index. + + <p>Example: <code>my.pkg.UserInfo~N+lastName+firstName-birthDate</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)"><code>parseNameDescriptor(String, StorableInfo)</code></a></dd></dl> +</li> +</ul> +<a name="getTypeDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTypeDescriptor</h4> +<pre>public java.lang.String getTypeDescriptor()</pre> +<div class="block">Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together. There is + one slight difference. Types which may be null are prefixed with a 'N' + character.</div> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Appends the same results as toString, but without the "StorableIndex" + prefix.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</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/StorableIndex.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/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableIndex.html" target="_top">Frames</a></li> +<li><a href="StorableIndex.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><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> diff --git a/apidocs/com/amazon/carbonado/info/StorableInfo.html b/apidocs/com/amazon/carbonado/info/StorableInfo.html new file mode 100644 index 0000000..ac528bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableInfo.html @@ -0,0 +1,522 @@ +<!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>StorableInfo (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="StorableInfo (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/StorableInfo.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/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableInfo.html" target="_top">Frames</a></li> +<li><a href="StorableInfo.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.info</div> +<h2 title="Interface StorableInfo" class="title">Interface StorableInfo<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 Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableInfo<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Archit Shivaprakash</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><code>StorableIntrospector</code></a></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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAlias(int)">getAlias</a></strong>(int index)</code> +<div class="block">Returns a specific alias for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAliasCount()">getAliasCount</a></strong>()</code> +<div class="block">Returns the count of aliases for the Storable.</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/info/StorableInfo.html#getAliases()">getAliases</a></strong>()</code> +<div class="block">Returns a new array with all the alias names in it.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Returns all the storable properties in an unmodifiable map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKey(int)">getAlternateKey</a></strong>(int index)</code> +<div class="block">Returns a specific alternate key for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeyCount()">getAlternateKeyCount</a></strong>()</code> +<div class="block">Returns the count of alternate keys for the Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeys()">getAlternateKeys</a></strong>()</code> +<div class="block">Returns a new array with all the alternate keys in it.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getDataProperties()">getDataProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.</div> +</td> +</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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getIndex(int)">getIndex</a></strong>(int index)</code> +<div class="block">Returns a specific index for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getIndexCount()">getIndexCount</a></strong>()</code> +<div class="block">Returns the count of indexes defined for the Storable.</div> +</td> +</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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getIndexes()">getIndexes</a></strong>()</code> +<div class="block">Returns a new array with all the indexes in it.</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/info/StorableInfo.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getPartitionKey()">getPartitionKey</a></strong>()</code> +<div class="block">Returns the partition key for the Storable, or null if none exists.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKey()">getPrimaryKey</a></strong>()</code> +<div class="block">Returns the primary key for the Storable, never null.</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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the type of Storable described by this StorableInfo.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getVersionProperty()">getVersionProperty</a></strong>()</code> +<div class="block">Returns the designated version property, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#isAuthoritative()">isAuthoritative</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#isIndependent()">isIndependent</a></strong>()</code> </td> +</tr> +</table> +</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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.</div> +</li> +</ul> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getStorableType()</pre> +<div class="block">Returns the type of Storable described by this StorableInfo.</div> +</li> +</ul> +<a name="getAllProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllProperties</h4> +<pre>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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>> getAllProperties()</pre> +<div class="block">Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getPrimaryKeyProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyProperties</h4> +<pre>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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>> getPrimaryKeyProperties()</pre> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getDataProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataProperties</h4> +<pre>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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>> getDataProperties()</pre> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. Primary keys and joins are + excluded. Properties are always ordered, case-sensitive, by name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getVersionProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionProperty</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getVersionProperty()</pre> +<div class="block">Returns the designated version property, or null if none.</div> +</li> +</ul> +<a name="getPrimaryKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKey</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getPrimaryKey()</pre> +<div class="block">Returns the primary key for the Storable, never null.</div> +</li> +</ul> +<a name="getAlternateKeyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlternateKeyCount</h4> +<pre>int getAlternateKeyCount()</pre> +<div class="block">Returns the count of alternate keys for the Storable.</div> +</li> +</ul> +<a name="getAlternateKey(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlternateKey</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getAlternateKey(int index)</pre> +<div class="block">Returns a specific alternate key for the Storable.</div> +</li> +</ul> +<a name="getAlternateKeys()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlternateKeys</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[] getAlternateKeys()</pre> +<div class="block">Returns a new array with all the alternate keys in it.</div> +</li> +</ul> +<a name="getPartitionKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitionKey</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getPartitionKey()</pre> +<div class="block">Returns the partition key for the Storable, or null if none exists.</div> +</li> +</ul> +<a name="getAliasCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAliasCount</h4> +<pre>int getAliasCount()</pre> +<div class="block">Returns the count of aliases for the Storable.</div> +</li> +</ul> +<a name="getAlias(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlias</h4> +<pre>java.lang.String getAlias(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific alias for the Storable.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getAliases()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAliases</h4> +<pre>java.lang.String[] getAliases()</pre> +<div class="block">Returns a new array with all the alias names in it.</div> +</li> +</ul> +<a name="getIndexCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexCount</h4> +<pre>int getIndexCount()</pre> +<div class="block">Returns the count of indexes defined for the Storable.</div> +</li> +</ul> +<a name="getIndex(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndex</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getIndex(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific index for the Storable.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getIndexes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexes</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[] getIndexes()</pre> +<div class="block">Returns a new array with all the indexes in it.</div> +</li> +</ul> +<a name="isIndependent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndependent</h4> +<pre>boolean isIndependent()</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a></dd></dl> +</li> +</ul> +<a name="isAuthoritative()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isAuthoritative</h4> +<pre>boolean isAuthoritative()</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><code>Authoritative</code></a></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/StorableInfo.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/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableInfo.html" target="_top">Frames</a></li> +<li><a href="StorableInfo.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> diff --git a/apidocs/com/amazon/carbonado/info/StorableIntrospector.html b/apidocs/com/amazon/carbonado/info/StorableIntrospector.html new file mode 100644 index 0000000..61f6695 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableIntrospector.html @@ -0,0 +1,319 @@ +<!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>StorableIntrospector (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="StorableIntrospector (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/StorableIntrospector.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/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="StorableIntrospector.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><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.info</div> +<h2 title="Class StorableIntrospector" class="title">Class StorableIntrospector</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorableIntrospector</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCStorableIntrospector</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorableIntrospector</span> +extends java.lang.Object</pre> +<div class="block">Supports examination of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types, returning all metadata + associated with it. As part of the examination, all annotations are gathered + up. All examined data is cached, so repeat examinations are fast, unless the + examination failed.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Fang Chen, Tobias Holgers, Archit Shivaprakash</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/info/StorableIntrospector.html#StorableIntrospector()">StorableIntrospector</a></strong>()</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>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)">examine</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Examines the given class and returns a StorableInfo describing it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#inferType(java.lang.Class)">inferType</a></strong>(java.lang.Class clazz)</code> +<div class="block">Examines a class and determines what Storable type it implements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#main(java.lang.String[])">main</a></strong>(java.lang.String[] args)</code> +<div class="block">Test program which examines candidate Storable classes.</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> +</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="StorableIntrospector()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorableIntrospector</h4> +<pre>public StorableIntrospector()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="main(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(java.lang.String[] args) + throws java.lang.Exception</pre> +<div class="block">Test program which examines candidate Storable classes. If any fail, an + exception is thrown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - names of classes to examine</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="examine(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>examine</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> examine(java.lang.Class<S> type)</pre> +<div class="block">Examines the given class and returns a StorableInfo describing it. A + MalformedTypeException is thrown for a variety of reasons if the given + class is an invalid Storable type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Storable type to examine</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if Storable type is invalid</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</dd></dl> +</li> +</ul> +<a name="inferType(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>inferType</h4> +<pre>public static java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> inferType(java.lang.Class clazz)</pre> +<div class="block">Examines a class and determines what Storable type it implements. If it + cannot be unambiguously inferred, null is returned. A non-null return + value does not imply that the Storable type is valid, however. It must + be <a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)"><code>examined</code></a> to check validity.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</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/StorableIntrospector.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/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="StorableIntrospector.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><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> diff --git a/apidocs/com/amazon/carbonado/info/StorableKey.html b/apidocs/com/amazon/carbonado/info/StorableKey.html new file mode 100644 index 0000000..5dc66cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableKey.html @@ -0,0 +1,245 @@ +<!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>StorableKey (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="StorableKey (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/StorableKey.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/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableKey.html" target="_top">Frames</a></li> +<li><a href="StorableKey.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.info</div> +<h2 title="Interface StorableKey" class="title">Interface StorableKey<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableKey<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</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/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><code>StorableIntrospector</code></a></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>java.util.Set<? extends <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="type parameter in StorableKey">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableKey.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns all the properties of the key in a properly ordered, + unmodifiable set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableKey.html#isPrimary()">isPrimary</a></strong>()</code> +<div class="block">Returns true if this key is primary, false otherwise.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.Appender"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</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="isPrimary()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrimary</h4> +<pre>boolean isPrimary()</pre> +<div class="block">Returns true if this key is primary, false otherwise.</div> +</li> +</ul> +<a name="getProperties()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>java.util.Set<? extends <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="type parameter in StorableKey">S</a>>> getProperties()</pre> +<div class="block">Returns all the properties of the key in a properly ordered, + unmodifiable set.</div> +</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/StorableKey.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/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableKey.html" target="_top">Frames</a></li> +<li><a href="StorableKey.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> diff --git a/apidocs/com/amazon/carbonado/info/StorableProperty.html b/apidocs/com/amazon/carbonado/info/StorableProperty.html new file mode 100644 index 0000000..66cdb58 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableProperty.html @@ -0,0 +1,929 @@ +<!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>StorableProperty (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="StorableProperty (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/StorableProperty.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/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableProperty.html" target="_top">Frames</a></li> +<li><a href="StorableProperty.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.info</div> +<h2 title="Interface StorableProperty" class="title">Interface StorableProperty<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.io.Serializable, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Tobias Holgers, Archit Shivaprakash</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><code>StorableIntrospector</code></a></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><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()">getAdapter</a></strong>()</code> +<div class="block">Returns this property's adapter, or null if none.</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/info/StorableProperty.html#getAlias(int)">getAlias</a></strong>(int index)</code> +<div class="block">Returns a specific alias for this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAliasCount()">getAliasCount</a></strong>()</code> +<div class="block">Returns the count of aliases for this property.</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/info/StorableProperty.html#getAliases()">getAliases</a></strong>()</code> +<div class="block">Returns a new array with all the alias names in it.</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/info/StorableProperty.html#getBeanName()">getBeanName</a></strong>()</code> +<div class="block">Returns the bean name of this property, which is derived from the read + and write method names.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraint(int)">getConstraint</a></strong>(int index)</code> +<div class="block">Returns a specific constraint for this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraintCount()">getConstraintCount</a></strong>()</code> +<div class="block">Returns the count of constraints for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraints()">getConstraints</a></strong>()</code> +<div class="block">Returns a new array with all the constraints in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<?>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getCovariantTypes()">getCovariantTypes</a></strong>()</code> +<div class="block">Returns additional types of this property, all of which are assignable + by the primary type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedFromProperties()">getDerivedFromProperties</a></strong>()</code> +<div class="block">Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedToProperties()">getDerivedToProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties which are derived from this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getEnclosingType()">getEnclosingType</a></strong>()</code> +<div class="block">Returns the enclosing type of this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">getExternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the external join elements in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">getInternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinedType()">getJoinedType</a></strong>()</code> +<div class="block">Returns the type of property this is joined to, or null if not joined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinElementCount()">getJoinElementCount</a></strong>()</code> +<div class="block">Returns the count of properties that participate in this property's + join.</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/info/StorableProperty.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of this property, which is the same as the bean name + unless it has been <a href="../../../../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado"><code>renamed</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getNumber()">getNumber</a></strong>()</code> +<div class="block">Returns the zero-based numerical position of this property within its + enclosing type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getReadMethod()">getReadMethod</a></strong>()</code> +<div class="block">Returns a no-arg method used to read the property value, or null if + reading is not allowed.</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/info/StorableProperty.html#getReadMethodName()">getReadMethodName</a></strong>()</code> +<div class="block">Returns the name of the read method, even if no read method was actually + declared.</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/info/StorableProperty.html#getSequenceName()">getSequenceName</a></strong>()</code> +<div class="block">Returns the property's sequence name, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getType()">getType</a></strong>()</code> +<div class="block">Returns the primary type of this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getWriteMethod()">getWriteMethod</a></strong>()</code> +<div class="block">Returns a one argument method used to write the property value, or null + if writing is not allowed.</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/info/StorableProperty.html#getWriteMethodName()">getWriteMethodName</a></strong>()</code> +<div class="block">Returns the name of the write method, even if no write method was + actually declared.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isAlternateKeyMember()">isAlternateKeyMember</a></strong>()</code> +<div class="block">Returns true if this property is a member of an alternate key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isAutomatic()">isAutomatic</a></strong>()</code> +<div class="block">Returns true of this property is given an automatic value upon insert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isDerived()">isDerived</a></strong>()</code> +<div class="block">Returns true if this property is derived.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isIndependent()">isIndependent</a></strong>()</code> +<div class="block">Returns true if this property has been designated independent.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isJoin()">isJoin</a></strong>()</code> +<div class="block">Returns true if this property is joined in any way to another Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isNullable()">isNullable</a></strong>()</code> +<div class="block">Returns true if this property can be null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isOneToOneJoin()">isOneToOneJoin</a></strong>()</code> +<div class="block">Returns true if this property is one-to-one joined to another Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isPartitionKeyMember()">isPartitionKeyMember</a></strong>()</code> +<div class="block">Returns true if this property is a member of a partition key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember</a></strong>()</code> +<div class="block">Returns true if this property is a member of a primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isQuery()">isQuery</a></strong>()</code> +<div class="block">Returns true if this property is a query, which also implies that it is + a join property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isVersion()">isVersion</a></strong>()</code> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#shouldCopyDerived()">shouldCopyDerived</a></strong>()</code> +<div class="block">Returns true if this derived property should be included when copying a + storable.</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/info/StorableProperty.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.Appender"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block">Returns the name of this property, which is the same as the bean name + unless it has been <a href="../../../../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado"><code>renamed</code></a>.</div> +</li> +</ul> +<a name="getBeanName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBeanName</h4> +<pre>java.lang.String getBeanName()</pre> +<div class="block">Returns the bean name of this property, which is derived from the read + and write method names.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>java.lang.Class<?> getType()</pre> +<div class="block">Returns the primary type of this property.</div> +</li> +</ul> +<a name="getCovariantTypes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCovariantTypes</h4> +<pre>java.lang.Class<?>[] getCovariantTypes()</pre> +<div class="block">Returns additional types of this property, all of which are assignable + by the primary type.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd></dl> +</li> +</ul> +<a name="getNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumber</h4> +<pre>int getNumber()</pre> +<div class="block">Returns the zero-based numerical position of this property within its + enclosing type.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getEnclosingType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnclosingType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>> getEnclosingType()</pre> +<div class="block">Returns the enclosing type of this property.</div> +</li> +</ul> +<a name="getReadMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadMethod</h4> +<pre>java.lang.reflect.Method getReadMethod()</pre> +<div class="block">Returns a no-arg method used to read the property value, or null if + reading is not allowed. The return type matches the type of this + property.</div> +</li> +</ul> +<a name="getReadMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadMethodName</h4> +<pre>java.lang.String getReadMethodName()</pre> +<div class="block">Returns the name of the read method, even if no read method was actually + declared. That is, this method always returns a method name, but + getReadMethod may still return null.</div> +</li> +</ul> +<a name="getWriteMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteMethod</h4> +<pre>java.lang.reflect.Method getWriteMethod()</pre> +<div class="block">Returns a one argument method used to write the property value, or null + if writing is not allowed. The first argument is the value to set, which + is the type of this property.</div> +</li> +</ul> +<a name="getWriteMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteMethodName</h4> +<pre>java.lang.String getWriteMethodName()</pre> +<div class="block">Returns the name of the write method, even if no write method was + actually declared. That is, this method always returns a method name, + but getWriteMethod may still return null.</div> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>boolean isNullable()</pre> +<div class="block">Returns true if this property can be null.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><code>Nullable</code></a></dd></dl> +</li> +</ul> +<a name="isPrimaryKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrimaryKeyMember</h4> +<pre>boolean isPrimaryKeyMember()</pre> +<div class="block">Returns true if this property is a member of a primary key.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><code>PrimaryKey</code></a></dd></dl> +</li> +</ul> +<a name="isAlternateKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAlternateKeyMember</h4> +<pre>boolean isAlternateKeyMember()</pre> +<div class="block">Returns true if this property is a member of an alternate key.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado"><code>AlternateKeys</code></a></dd></dl> +</li> +</ul> +<a name="isPartitionKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPartitionKeyMember</h4> +<pre>boolean isPartitionKeyMember()</pre> +<div class="block">Returns true if this property is a member of a partition key.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado"><code>PartitionKey</code></a></dd></dl> +</li> +</ul> +<a name="getAliasCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAliasCount</h4> +<pre>int getAliasCount()</pre> +<div class="block">Returns the count of aliases for this property.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a></dd></dl> +</li> +</ul> +<a name="getAlias(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlias</h4> +<pre>java.lang.String getAlias(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific alias for this property.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a></dd></dl> +</li> +</ul> +<a name="getAliases()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAliases</h4> +<pre>java.lang.String[] getAliases()</pre> +<div class="block">Returns a new array with all the alias names in it.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a></dd></dl> +</li> +</ul> +<a name="isJoin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isJoin</h4> +<pre>boolean isJoin()</pre> +<div class="block">Returns true if this property is joined in any way to another Storable.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a></dd></dl> +</li> +</ul> +<a name="isOneToOneJoin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOneToOneJoin</h4> +<pre>boolean isOneToOneJoin()</pre> +<div class="block">Returns true if this property is one-to-one joined to another Storable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a></dd></dl> +</li> +</ul> +<a name="getJoinedType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJoinedType</h4> +<pre>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getJoinedType()</pre> +<div class="block">Returns the type of property this is joined to, or null if not joined.</div> +</li> +</ul> +<a name="getJoinElementCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJoinElementCount</h4> +<pre>int getJoinElementCount()</pre> +<div class="block">Returns the count of properties that participate in this property's + join. If this property is not a join, then zero is returned.</div> +</li> +</ul> +<a name="getInternalJoinElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalJoinElement</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>> getInternalJoinElement(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getInternalJoinElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalJoinElements</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[] getInternalJoinElements()</pre> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</li> +</ul> +<a name="getExternalJoinElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExternalJoinElement</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> getExternalJoinElement(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getExternalJoinElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExternalJoinElements</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] getExternalJoinElements()</pre> +<div class="block">Returns a new array with all the external join elements in it.</div> +</li> +</ul> +<a name="isQuery()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isQuery</h4> +<pre>boolean isQuery()</pre> +<div class="block">Returns true if this property is a query, which also implies that it is + a join property.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a></dd></dl> +</li> +</ul> +<a name="getConstraintCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstraintCount</h4> +<pre>int getConstraintCount()</pre> +<div class="block">Returns the count of constraints for this property.</div> +</li> +</ul> +<a name="getConstraint(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstraint</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a> getConstraint(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific constraint for this property.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getConstraints()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstraints</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a>[] getConstraints()</pre> +<div class="block">Returns a new array with all the constraints in it.</div> +</li> +</ul> +<a name="getAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapter</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> getAdapter()</pre> +<div class="block">Returns this property's adapter, or null if none.</div> +</li> +</ul> +<a name="getSequenceName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSequenceName</h4> +<pre>java.lang.String getSequenceName()</pre> +<div class="block">Returns the property's sequence name, or null if none.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a></dd></dl> +</li> +</ul> +<a name="isAutomatic()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutomatic</h4> +<pre>boolean isAutomatic()</pre> +<div class="block">Returns true of this property is given an automatic value upon insert.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado"><code>Automatic</code></a></dd></dl> +</li> +</ul> +<a name="isVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersion</h4> +<pre>boolean isVersion()</pre> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>Version</code></a></dd></dl> +</li> +</ul> +<a name="isIndependent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndependent</h4> +<pre>boolean isIndependent()</pre> +<div class="block">Returns true if this property has been designated independent.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a></dd></dl> +</li> +</ul> +<a name="isDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDerived</h4> +<pre>boolean isDerived()</pre> +<div class="block">Returns true if this property is derived.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><code>Derived</code></a></dd></dl> +</li> +</ul> +<a name="getDerivedFromProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDerivedFromProperties</h4> +<pre><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[] getDerivedFromProperties()</pre> +<div class="block">Returns a new array with all the derived-from properties, which is empty + if this is not a derived property. Otherwise, the set is the transitive + closure of all dependent properties. This set may include joins and + other derived properties.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getDerivedToProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDerivedToProperties</h4> +<pre><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?>[] getDerivedToProperties()</pre> +<div class="block">Returns a new array with all the properties which are derived from this + one. The set is the transitive closure of all derived properties which + depend on this one. + + <p>Each property in the set is represented as a chain, where the prime + property is the actual dependent property, and the tail is the path to + reach this property's enclosing type. If a derived property resides in + the same enclosing type as this one, the chain count is zero.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="shouldCopyDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldCopyDerived</h4> +<pre>boolean shouldCopyDerived()</pre> +<div class="block">Returns true if this derived property should be included when copying a + storable. Copying of a derived property uses the "get" and "set" methods + and requires the "set" method to be defined.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/StorableProperty.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/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableProperty.html" target="_top">Frames</a></li> +<li><a href="StorableProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html b/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html new file mode 100644 index 0000000..fb3e3c2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html @@ -0,0 +1,432 @@ +<!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>StorablePropertyAdapter (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="StorablePropertyAdapter (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/StorablePropertyAdapter.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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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><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.info</div> +<h2 title="Class StorablePropertyAdapter" class="title">Class StorablePropertyAdapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorablePropertyAdapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyAdapter</span> +extends java.lang.Object</pre> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</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"> +<!-- ======== 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/info/StorablePropertyAdapter.html#StorablePropertyAdapter(java.lang.String, java.lang.Class, java.lang.Class)">StorablePropertyAdapter</a></strong>(java.lang.String propertyName, + java.lang.Class<?> propertyType, + java.lang.Class<? extends java.lang.annotation.Annotation> adapterType)</code> +<div class="block">Construct a generic StorablePropertyAdapter instance not attached to a + storable definition.</div> +</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>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethod(java.lang.Class, java.lang.Class)">findAdaptMethod</a></strong>(java.lang.Class from, + java.lang.Class to)</code> +<div class="block">Returns an adapt method that supports the given conversion, or null if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethodsFrom(java.lang.Class)">findAdaptMethodsFrom</a></strong>(java.lang.Class from)</code> +<div class="block">Returns all the adapt methods that convert from the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethodsTo(java.lang.Class)">findAdaptMethodsTo</a></strong>(java.lang.Class to)</code> +<div class="block">Returns all the adapt methods that convert to the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Constructor</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterConstructor()">getAdapterConstructor</a></strong>()</code> +<div class="block">Returns the constructor for the adapter class.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterInstance()">getAdapterInstance</a></strong>()</code> +<div class="block">Returns an instance of the adapter, for which an adapt method is applied to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethod(int)">getAdaptMethod</a></strong>(int index)</code> +<div class="block">Returns a specific adapt method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethodCount()">getAdaptMethodCount</a></strong>()</code> +<div class="block">Returns the count of all defined adapt methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethods()">getAdaptMethods</a></strong>()</code> +<div class="block">Returns a new array with all the adapt methods in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getStorageTypePreferences()">getStorageTypePreferences</a></strong>()</code> +<div class="block">Returns the adapter's storage type preferences.</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> +</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="StorablePropertyAdapter(java.lang.String, java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorablePropertyAdapter</h4> +<pre>public StorablePropertyAdapter(java.lang.String propertyName, + java.lang.Class<?> propertyType, + java.lang.Class<? extends java.lang.annotation.Annotation> adapterType)</pre> +<div class="block">Construct a generic StorablePropertyAdapter instance not attached to a + storable definition. Call <a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()"><code>StorableProperty.getAdapter()</code></a> to gain + access to adapter information on actual storable definitions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property with adapter</dd><dd><code>propertyType</code> - declated type of adapted property</dd><dd><code>adapterType</code> - adapter type</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if adapterType is not an adapter + definition.</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="getAnnotation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotation</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a> getAnnotation()</pre> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</li> +</ul> +<a name="getAdapterConstructor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterConstructor</h4> +<pre>public java.lang.reflect.Constructor getAdapterConstructor()</pre> +<div class="block">Returns the constructor for the adapter class. It has the signature + <code>(Class type, String propertyName, <i>Annotation</i>)</code>, where + <i>Annotation</i> is the fully resolved annotation.</div> +</li> +</ul> +<a name="getAdapterInstance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterInstance</h4> +<pre>public java.lang.Object getAdapterInstance()</pre> +<div class="block">Returns an instance of the adapter, for which an adapt method is applied to.</div> +</li> +</ul> +<a name="getStorageTypePreferences()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageTypePreferences</h4> +<pre>public java.lang.Class[] getStorageTypePreferences()</pre> +<div class="block">Returns the adapter's storage type preferences.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()"><code>AdapterDefinition.storageTypePreferences()</code></a></dd></dl> +</li> +</ul> +<a name="findAdaptMethod(java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethod</h4> +<pre>public java.lang.reflect.Method findAdaptMethod(java.lang.Class from, + java.lang.Class to)</pre> +<div class="block">Returns an adapt method that supports the given conversion, or null if + none.</div> +</li> +</ul> +<a name="findAdaptMethodsFrom(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethodsFrom</h4> +<pre>public java.lang.reflect.Method[] findAdaptMethodsFrom(java.lang.Class from)</pre> +<div class="block">Returns all the adapt methods that convert from the given type.</div> +</li> +</ul> +<a name="findAdaptMethodsTo(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethodsTo</h4> +<pre>public java.lang.reflect.Method[] findAdaptMethodsTo(java.lang.Class to)</pre> +<div class="block">Returns all the adapt methods that convert to the given type.</div> +</li> +</ul> +<a name="getAdaptMethodCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdaptMethodCount</h4> +<pre>public int getAdaptMethodCount()</pre> +<div class="block">Returns the count of all defined adapt methods.</div> +</li> +</ul> +<a name="getAdaptMethod(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdaptMethod</h4> +<pre>public java.lang.reflect.Method getAdaptMethod(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific adapt method.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getAdaptMethods()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAdaptMethods</h4> +<pre>public java.lang.reflect.Method[] getAdaptMethods()</pre> +<div class="block">Returns a new array with all the adapt methods in it.</div> +</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/StorablePropertyAdapter.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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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><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> diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html b/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html new file mode 100644 index 0000000..331aad5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html @@ -0,0 +1,324 @@ +<!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>StorablePropertyAnnotation (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="StorablePropertyAnnotation (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/StorablePropertyAnnotation.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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAnnotation.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAnnotation.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><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.info</div> +<h2 title="Class StorablePropertyAnnotation" class="title">Class StorablePropertyAnnotation</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorablePropertyAnnotation</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyAnnotation</span> +extends java.lang.Object</pre> +<div class="block">Information about a custom annotation applied to a property.</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"> +<!-- ======== 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/info/StorablePropertyAnnotation.html#StorablePropertyAnnotation(java.lang.annotation.Annotation, java.lang.reflect.Method)">StorablePropertyAnnotation</a></strong>(java.lang.annotation.Annotation annotation, + java.lang.reflect.Method method)</code> +<div class="block">Use this constructor if an annotation was actually defined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#StorablePropertyAnnotation(java.lang.Class, java.lang.reflect.Method)">StorablePropertyAnnotation</a></strong>(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, + java.lang.reflect.Method method)</code> +<div class="block">Use this constructor if an annotation was not defined, but instead is + being automatically applied.</div> +</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>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotatedMethod()">getAnnotatedMethod</a></strong>()</code> +<div class="block">Returns the method that has the annotation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.annotation.Annotation</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the actual annotation instance, which may be null if annotation + was automatically applied.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends java.lang.annotation.Annotation></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotationType()">getAnnotationType</a></strong>()</code> +<div class="block">Returns the type of annotation that was applied to the property method.</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> +</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="StorablePropertyAnnotation(java.lang.annotation.Annotation, java.lang.reflect.Method)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorablePropertyAnnotation</h4> +<pre>public StorablePropertyAnnotation(java.lang.annotation.Annotation annotation, + java.lang.reflect.Method method)</pre> +<div class="block">Use this constructor if an annotation was actually defined.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>annotation</code> - annotation on method</dd><dd><code>method</code> - method with annotation</dd></dl> +</li> +</ul> +<a name="StorablePropertyAnnotation(java.lang.Class, java.lang.reflect.Method)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorablePropertyAnnotation</h4> +<pre>public StorablePropertyAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, + java.lang.reflect.Method method)</pre> +<div class="block">Use this constructor if an annotation was not defined, but instead is + being automatically applied.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>annotationType</code> - annotation type on method</dd><dd><code>method</code> - method with annotation</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="getAnnotation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotation</h4> +<pre>public java.lang.annotation.Annotation getAnnotation()</pre> +<div class="block">Returns the actual annotation instance, which may be null if annotation + was automatically applied.</div> +</li> +</ul> +<a name="getAnnotationType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotationType</h4> +<pre>public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationType()</pre> +<div class="block">Returns the type of annotation that was applied to the property method.</div> +</li> +</ul> +<a name="getAnnotatedMethod()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAnnotatedMethod</h4> +<pre>public java.lang.reflect.Method getAnnotatedMethod()</pre> +<div class="block">Returns the method that has the annotation.</div> +</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/StorablePropertyAnnotation.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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAnnotation.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAnnotation.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><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> diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html b/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html new file mode 100644 index 0000000..5d682cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html @@ -0,0 +1,264 @@ +<!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>StorablePropertyConstraint (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="StorablePropertyConstraint (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/StorablePropertyConstraint.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/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyConstraint.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyConstraint.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.info</div> +<h2 title="Class StorablePropertyConstraint" class="title">Class StorablePropertyConstraint</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorablePropertyConstraint</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyConstraint</span> +extends java.lang.Object</pre> +<div class="block">Information about a <a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><code>constraint</code></a> annotation applied to a property.</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><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this constraint.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html#getConstrainMethod()">getConstrainMethod</a></strong>()</code> +<div class="block">Returns the best matching property checking method in the validator.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Constructor</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html#getConstraintConstructor()">getConstraintConstructor</a></strong>()</code> +<div class="block">Returns the constructor for the constraint class.</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> +</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="getAnnotation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotation</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a> getAnnotation()</pre> +<div class="block">Returns the annotation that applied this constraint.</div> +</li> +</ul> +<a name="getConstraintConstructor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstraintConstructor</h4> +<pre>public java.lang.reflect.Constructor getConstraintConstructor()</pre> +<div class="block">Returns the constructor for the constraint class. It has the signature + <code>(Class type, String propertyName, <i>Annotation</i>)</code>, where + <i>Annotation</i> is the fully resolved annotation.</div> +</li> +</ul> +<a name="getConstrainMethod()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConstrainMethod</h4> +<pre>public java.lang.reflect.Method getConstrainMethod()</pre> +<div class="block">Returns the best matching property checking method in the validator.</div> +</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/StorablePropertyConstraint.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/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyConstraint.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyConstraint.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html b/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html new file mode 100644 index 0000000..5b8c49d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html @@ -0,0 +1,385 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.info.ChainedProperty (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="Uses of Class com.amazon.carbonado.info.ChainedProperty (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><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/ChainedProperty.html" target="_top">Frames</a></li> +<li><a href="ChainedProperty.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"> +<h2 title="Uses of Class com.amazon.carbonado.info.ChainedProperty" class="title">Uses of Class<br>com.amazon.carbonado.info.ChainedProperty</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#getChainedProperty()">getChainedProperty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#getChainedProperty()">getChainedProperty</a></strong>()</code> +<div class="block">Returns the join property that is being checked for existence or + non-existence.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Prepends a join property to all properties of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><T></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">OrFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><T></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">AndFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><T></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><T></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> joinProperty)</code> +<div class="block">Removes a join property prefix from all applicable properties of this + filter.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.ChainedProperty)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty, boolean)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property, + boolean outerJoin)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</code> +<div class="block">Returns a canonical instance which has no chain.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#getChainedProperty()">getChainedProperty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedFromProperties()">getDerivedFromProperties</a></strong>()</code> +<div class="block">Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedToProperties()">getDerivedToProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties which are derived from this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses a chained property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#tail()">tail</a></strong>()</code> +<div class="block">Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#trim()">trim</a></strong>()</code> +<div class="block">Returns a new ChainedProperty with the last property in the chain removed.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.ChainedProperty)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignProperty()">getForeignProperty</a></strong>()</code> +<div class="block">Returns the simple or chained property that maps to the selected + foreign index.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/ChainedProperty.html" target="_top">Frames</a></li> +<li><a href="ChainedProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/Direction.html b/apidocs/com/amazon/carbonado/info/class-use/Direction.html new file mode 100644 index 0000000..8e942f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/Direction.html @@ -0,0 +1,432 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.info.Direction (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="Uses of Class com.amazon.carbonado.info.Direction (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><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/Direction.html" target="_top">Frames</a></li> +<li><a href="Direction.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"> +<h2 title="Uses of Class com.amazon.carbonado.info.Direction" class="title">Uses of Class<br>com.amazon.carbonado.info.Direction</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns the directions of all the properties in this index.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">Direction.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/Direction.html#fromCharacter(char)">fromCharacter</a></strong>(char c)</code> +<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#getDirection()">getDirection</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirection(int)">getPropertyDirection</a></strong>(int index)</code> +<div class="block">Returns the requested direction of a specific property in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns a new array with all the property directions in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">Direction.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/Direction.html#reverse()">reverse</a></strong>()</code> +<div class="block">Returns the reverse direction of this.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">Direction.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/Direction.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><span class="strong">Direction.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/Direction.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></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> +<tbody> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex with the given property added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#direction(com.amazon.carbonado.info.Direction)">direction</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique, + boolean clustered)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">addIndexes</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#reduce(com.amazon.carbonado.info.Direction)">reduce</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Set the default direction for all index properties.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfoImpl.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#IndexInfoImpl(java.lang.String, boolean, boolean, java.lang.String[], com.amazon.carbonado.info.Direction[])">IndexInfoImpl</a></strong>(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] propertyDirections)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addKeyProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addKeyProperty</a></strong>(java.lang.String name, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Add a property to the primary key which is a member of the Storable type + being referenced by this one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticPropertyList.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Adds a property to this index, with the specified direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/Direction.html" target="_top">Frames</a></li> +<li><a href="Direction.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/OrderedProperty.html b/apidocs/com/amazon/carbonado/info/class-use/OrderedProperty.html new file mode 100644 index 0000000..7567255 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/OrderedProperty.html @@ -0,0 +1,447 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.info.OrderedProperty (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="Uses of Class com.amazon.carbonado.info.OrderedProperty (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><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/OrderedProperty.html" target="_top">Frames</a></li> +<li><a href="OrderedProperty.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"> +<h2 title="Uses of Class com.amazon.carbonado.info.OrderedProperty" class="title">Uses of Class<br>com.amazon.carbonado.info.OrderedProperty</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a> in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.util.Comparator<S></code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(com.amazon.carbonado.info.OrderedProperty...)">createComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... properties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with type arguments of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.util.Comparator<S></code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(java.util.List)">createComparator</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> properties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#direction(com.amazon.carbonado.info.Direction)">direction</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperties()">getOrderedProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties in it, with directions + folded in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperty(int)">getOrderedProperty</a></strong>(int index)</code> +<div class="block">Returns a specific property in this index, with the direction folded in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#reverse()">reverse</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<? extends <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="type parameter in StorableKey">S</a>>></code></td> +<td class="colLast"><span class="strong">StorableKey.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableKey.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns all the properties of the key in a properly ordered, + unmodifiable set.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(int)">get</a></strong>(int index)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.info.OrderedProperty)">concat</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#replace(int, com.amazon.carbonado.info.OrderedProperty)">replace</a></strong>(int index, + <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list with the given element replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with type arguments of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllKeyProperties()">gatherAllKeyProperties</a></strong>()</code> +<div class="block">Returns all key properties as ordered properties, possibly with + unspecified directions.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable)">buildKeyDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable, org.cojen.classfile.LocalVariable)">buildKeyEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + org.cojen.classfile.LocalVariable partialStartVar, + org.cojen.classfile.LocalVariable partialEndVar)</code> +<div class="block">Generates bytecode instructions to encode properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a><<a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getSearchKeyFactory(com.amazon.carbonado.info.OrderedProperty[])">getSearchKeyFactory</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>>[] properties)</code> +<div class="block">Returns a search key factory, which is useful for implementing indexes + and queries.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/OrderedProperty.html" target="_top">Frames</a></li> +<li><a href="OrderedProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html b/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html new file mode 100644 index 0000000..16c5fe8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html @@ -0,0 +1,544 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.info.StorableIndex (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="Uses of Class com.amazon.carbonado.info.StorableIndex (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><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableIndex.html" target="_top">Frames</a></li> +<li><a href="StorableIndex.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"> +<h2 title="Uses of Class com.amazon.carbonado.info.StorableIndex" class="title">Uses of Class<br>com.amazon.carbonado.info.StorableIndex</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></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> +<tbody> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex with the given property added.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#clustered(boolean)">clustered</a></strong>(boolean clustered)</code> +<div class="block">Returns a StorableIndex instance which is clustered or not.</div> +</td> +</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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getIndex(int)">getIndex</a></strong>(int index)</code> +<div class="block">Returns a specific index for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getIndexes()">getIndexes</a></strong>()</code> +<div class="block">Returns a new array with all the indexes in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)">parseNameDescriptor</a></strong>(java.lang.String desc, + <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info)</code> +<div class="block">Parses an index descriptor and returns an index object.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#reverse()">reverse</a></strong>()</code> +<div class="block">Returns a StorableIndex instance with all the properties reversed.</div> +</td> +</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#unique(boolean)">unique</a></strong>(boolean unique)</code> +<div class="block">Returns a StorableIndex instance which is unique or not.</div> +</td> +</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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key)</code> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></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> +<tbody> +<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/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findKeyIndex(com.amazon.carbonado.info.StorableKey)">findKeyIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Finds the best index to represent the given key.</div> +</td> +</tr> +<tr class="rowColor"> +<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/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">findPrimaryKeyIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Finds the best index to represent the primary key.</div> +</td> +</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><?></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignIndex()">getForeignIndex</a></strong>()</code> +<div class="block">Returns the foreign index that was selected, or null if a local + index was selected.</div> +</td> +</tr> +<tr class="rowColor"> +<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/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getLocalIndex()">getLocalIndex</a></strong>()</code> +<div class="block">Returns the local index that was selected, or null if a foreign + index was selected.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Collection<<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>>></code></td> +<td class="colLast"><span class="strong">StorageAccess.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html#getAllIndexes()">getAllIndexes</a></strong>()</code> +<div class="block">Returns all the available indexes.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index)</code> +<div class="block">Returns an open query if the given index supports query access.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><span class="strong">StorageAccess.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html#storageDelegate(com.amazon.carbonado.info.StorableIndex)">storageDelegate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> index)</code> +<div class="block">If the given index is not directly supported by storage, queries should + be delegated.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></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> +<tbody> +<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"><span class="strong">CustomStorableCodec.</span><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><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>></code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> +<div class="block">Returns all key properties in the form of an index.</div> +</td> +</tr> +<tr class="rowColor"> +<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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#CompressedEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.raw.CompressionType)">CompressedEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> pkIndex, + <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> compressionType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">GenericEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> pkIndex)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, int, int, int, int)">GenericEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> pkIndex, + int keyPrefixPadding, + int keySuffixPadding, + int dataPrefixPadding, + int dataSuffixPadding)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableIndex.html" target="_top">Frames</a></li> +<li><a href="StorableIndex.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html b/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html new file mode 100644 index 0000000..dc7e131 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html @@ -0,0 +1,288 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.info.StorableInfo (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="Uses of Interface com.amazon.carbonado.info.StorableInfo (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><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableInfo.html" target="_top">Frames</a></li> +<li><a href="StorableInfo.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"> +<h2 title="Uses of Interface com.amazon.carbonado.info.StorableInfo" class="title">Uses of Interface<br>com.amazon.carbonado.info.StorableInfo</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S></code></td> +<td class="colLast"><span class="strong">StorableIntrospector.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)">examine</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Examines the given class and returns a StorableInfo describing it.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses a chained property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)">parseNameDescriptor</a></strong>(java.lang.String desc, + <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info)</code> +<div class="block">Parses an index descriptor and returns an index object.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addAlternateKeys(com.amazon.carbonado.info.StorableInfo)">addAlternateKeys</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds all of the alternate keys of the given storable as indexes by + calling <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo)">addIndexes</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">addIndexes</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)">addPrimaryKey</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</td> +</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/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">findPrimaryKeyIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Finds the best index to represent the primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableInfo)">uniquify</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Augment non-unique indexes with primary key properties, thus making them + unique.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as + needed by JDBCRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableInfo.html" target="_top">Frames</a></li> +<li><a href="StorableInfo.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableIntrospector.html b/apidocs/com/amazon/carbonado/info/class-use/StorableIntrospector.html new file mode 100644 index 0000000..bb3e29d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableIntrospector.html @@ -0,0 +1,163 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.info.StorableIntrospector (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="Uses of Class com.amazon.carbonado.info.StorableIntrospector (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><a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="StorableIntrospector.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"> +<h2 title="Uses of Class com.amazon.carbonado.info.StorableIntrospector" class="title">Uses of Class<br>com.amazon.carbonado.info.StorableIntrospector</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCStorableIntrospector</a></strong></code> +<div class="block">Provides additional metadata for a <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type needed by + JDBCRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="StorableIntrospector.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html new file mode 100644 index 0000000..377457c --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html @@ -0,0 +1,247 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.info.StorableKey (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="Uses of Interface com.amazon.carbonado.info.StorableKey (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><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableKey.html" target="_top">Frames</a></li> +<li><a href="StorableKey.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"> +<h2 title="Uses of Interface com.amazon.carbonado.info.StorableKey" class="title">Uses of Interface<br>com.amazon.carbonado.info.StorableKey</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKey(int)">getAlternateKey</a></strong>(int index)</code> +<div class="block">Returns a specific alternate key for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeys()">getAlternateKeys</a></strong>()</code> +<div class="block">Returns a new array with all the alternate keys in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPartitionKey()">getPartitionKey</a></strong>()</code> +<div class="block">Returns the partition key for the Storable, or null if none exists.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKey()">getPrimaryKey</a></strong>()</code> +<div class="block">Returns the primary key for the Storable, never null.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></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> +<tbody> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key)</code> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)">addKey</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Adds the key as a unique index, preserving the property arrangement.</div> +</td> +</tr> +<tr class="rowColor"> +<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/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findKeyIndex(com.amazon.carbonado.info.StorableKey)">findKeyIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Finds the best index to represent the given key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Augment non-unique indexes with key properties, thus making them unique.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableKey.html" target="_top">Frames</a></li> +<li><a href="StorableKey.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html b/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html new file mode 100644 index 0000000..f71a060 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html @@ -0,0 +1,479 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.info.StorableProperty (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="Uses of Interface com.amazon.carbonado.info.StorableProperty (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><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableProperty.html" target="_top">Frames</a></li> +<li><a href="StorableProperty.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"> +<h2 title="Uses of Interface com.amazon.carbonado.info.StorableProperty" class="title">Uses of Interface<br>com.amazon.carbonado.info.StorableProperty</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#getChainedProperty(int)">getChainedProperty</a></strong>(int index)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">getExternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the external join elements in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">getInternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#getLastProperty()">getLastProperty</a></strong>()</code> +<div class="block">Returns the last property in the chain, or the prime property if chain + is empty.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#getPrimeProperty()">getPrimeProperty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getProperty(int)">getProperty</a></strong>(int index)</code> +<div class="block">Returns a specific property in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getVersionProperty()">getVersionProperty</a></strong>()</code> +<div class="block">Returns the designated version property, or null if none.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></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> +<tbody> +<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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Returns all the storable properties in an unmodifiable map.</div> +</td> +</tr> +<tr class="rowColor"> +<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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getDataProperties()">getDataProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.</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/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></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> +<tbody> +<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/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex with the given property added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty, boolean)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property, + boolean outerJoin)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</code> +<div class="block">Returns a canonical instance which has no chain.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique, + boolean clustered)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllDataProperties()">gatherAllDataProperties</a></strong>()</code> +<div class="block">Returns all non-derived data properties for storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllProperties()">gatherAllProperties</a></strong>()</code> +<div class="block">Returns all non-join, non-derived properties for storable.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></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> +<tbody> +<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"><span class="strong">CustomStorableCodec.</span><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> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)">buildDataDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + int generation, + org.cojen.classfile.Label altGenerationHandler, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int)">buildDataEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + int generation)</code> +<div class="block">Generates bytecode instructions to encode properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable)">buildSerialDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties and their states.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[])">buildSerialEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> +<div class="block">Generates bytecode instructions to encode properties and their + states.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty)">checkSupport</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> property)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty[])">checkSupport</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as needed by JDBCRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorableProperty.html" target="_top">Frames</a></li> +<li><a href="StorableProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html new file mode 100644 index 0000000..f3a6673 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html @@ -0,0 +1,229 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.info.StorablePropertyAdapter (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="Uses of Class com.amazon.carbonado.info.StorablePropertyAdapter (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><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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"> +<h2 title="Uses of Class com.amazon.carbonado.info.StorablePropertyAdapter" class="title">Uses of Class<br>com.amazon.carbonado.info.StorablePropertyAdapter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()">getAdapter</a></strong>()</code> +<div class="block">Returns this property's adapter, or null if none.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><span class="strong">JDBCStorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getAppliedAdapter()">getAppliedAdapter</a></strong>()</code> +<div class="block">Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><span class="strong">SyntheticProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getAdapter()">getAdapter</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#setAdapter(com.amazon.carbonado.info.StorablePropertyAdapter)">setAdapter</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> adapter)</code> +<div class="block">Storables cannot currently have more than one adapter per property.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html new file mode 100644 index 0000000..ac1c091 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.info.StorablePropertyAnnotation (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="Uses of Class com.amazon.carbonado.info.StorablePropertyAnnotation (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><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAnnotation.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"> +<h2 title="Uses of Class com.amazon.carbonado.info.StorablePropertyAnnotation" class="title">Uses of Class<br>com.amazon.carbonado.info.StorablePropertyAnnotation</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><span class="strong">StorablePropertyAdapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><span class="strong">StorablePropertyConstraint.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this constraint.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAnnotation.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html new file mode 100644 index 0000000..fca5817 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.info.StorablePropertyConstraint (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="Uses of Class com.amazon.carbonado.info.StorablePropertyConstraint (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><a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyConstraint.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"> +<h2 title="Uses of Class com.amazon.carbonado.info.StorablePropertyConstraint" class="title">Uses of Class<br>com.amazon.carbonado.info.StorablePropertyConstraint</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraint(int)">getConstraint</a></strong>(int index)</code> +<div class="block">Returns a specific constraint for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraints()">getConstraints</a></strong>()</code> +<div class="block">Returns a new array with all the constraints in it.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyConstraint.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> diff --git a/apidocs/com/amazon/carbonado/info/package-frame.html b/apidocs/com/amazon/carbonado/info/package-frame.html new file mode 100644 index 0000000..56882b7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-frame.html @@ -0,0 +1,36 @@ +<!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.info (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/info/package-summary.html" target="classFrame">com.amazon.carbonado.info</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="StorableInfo.html" title="interface in com.amazon.carbonado.info" target="classFrame"><i>StorableInfo</i></a></li> +<li><a href="StorableKey.html" title="interface in com.amazon.carbonado.info" target="classFrame"><i>StorableKey</i></a></li> +<li><a href="StorableProperty.html" title="interface in com.amazon.carbonado.info" target="classFrame"><i>StorableProperty</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ChainedProperty.html" title="class in com.amazon.carbonado.info" target="classFrame">ChainedProperty</a></li> +<li><a href="OrderedProperty.html" title="class in com.amazon.carbonado.info" target="classFrame">OrderedProperty</a></li> +<li><a href="StorableIndex.html" title="class in com.amazon.carbonado.info" target="classFrame">StorableIndex</a></li> +<li><a href="StorableIntrospector.html" title="class in com.amazon.carbonado.info" target="classFrame">StorableIntrospector</a></li> +<li><a href="StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info" target="classFrame">StorablePropertyAdapter</a></li> +<li><a href="StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info" target="classFrame">StorablePropertyAnnotation</a></li> +<li><a href="StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info" target="classFrame">StorablePropertyConstraint</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="Direction.html" title="enum in com.amazon.carbonado.info" target="classFrame">Direction</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/info/package-summary.html b/apidocs/com/amazon/carbonado/info/package-summary.html new file mode 100644 index 0000000..166687d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-summary.html @@ -0,0 +1,230 @@ +<!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.info (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.info (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><a href="../../../../com/amazon/carbonado/gen/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/layout/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/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.info</h1> +<div class="docSummary"> +<div class="block">Introspection support for Storables.</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/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</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">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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">Represents a property to filter on or to order by.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></td> +<td class="colLast"> +<div class="block">Supports examination of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types, returning all metadata + associated with it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></td> +<td class="colLast"> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></td> +<td class="colLast"> +<div class="block">Information about a custom annotation applied to a property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></td> +<td class="colLast"> +<div class="block">Information about a <a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><code>constraint</code></a> annotation applied to a property.</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/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></td> +<td class="colLast"> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.info Description">Package com.amazon.carbonado.info Description</h2> +<div class="block">Introspection support for Storables.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><code>StorableIntrospector</code></a></dd></dl> +</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><a href="../../../../com/amazon/carbonado/gen/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/layout/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/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> diff --git a/apidocs/com/amazon/carbonado/info/package-tree.html b/apidocs/com/amazon/carbonado/info/package-tree.html new file mode 100644 index 0000000..e755e36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-tree.html @@ -0,0 +1,163 @@ +<!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.info Class Hierarchy (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.info Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/gen/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/layout/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.info</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">ChainedProperty</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable)</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">OrderedProperty</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable)</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">StorableIndex</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>)</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">StorableIntrospector</span></a></li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyAdapter</span></a></li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyAnnotation</span></a></li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyConstraint</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Appender</span></a> +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableKey</span></a><S></li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableProperty</span></a><S> (also extends java.io.Serializable)</li> +</ul> +</li> +<li type="circle">java.io.Serializable +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableProperty</span></a><S> (also extends com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableInfo</span></a><S></li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Direction</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/gen/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/layout/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/info/package-use.html b/apidocs/com/amazon/carbonado/info/package-use.html new file mode 100644 index 0000000..5d3c1c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-use.html @@ -0,0 +1,443 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.info (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="Uses of Package com.amazon.carbonado.info (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.info" class="title">Uses of Package<br>com.amazon.carbonado.info</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.capability">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/OrderedProperty.html#com.amazon.carbonado.cursor">OrderedProperty</a> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/ChainedProperty.html#com.amazon.carbonado.filter">ChainedProperty</a> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/ChainedProperty.html#com.amazon.carbonado.info">ChainedProperty</a> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.info">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/OrderedProperty.html#com.amazon.carbonado.info">OrderedProperty</a> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableIndex.html#com.amazon.carbonado.info">StorableIndex</a> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableInfo.html#com.amazon.carbonado.info">StorableInfo</a> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableKey.html#com.amazon.carbonado.info">StorableKey</a> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableProperty.html#com.amazon.carbonado.info">StorableProperty</a> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html#com.amazon.carbonado.info">StorablePropertyAdapter</a> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html#com.amazon.carbonado.info">StorablePropertyAnnotation</a> +<div class="block">Information about a custom annotation applied to a property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html#com.amazon.carbonado.info">StorablePropertyConstraint</a> +<div class="block">Information about a <a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><code>constraint</code></a> annotation applied to a property.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/ChainedProperty.html#com.amazon.carbonado.qe">ChainedProperty</a> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.qe">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/OrderedProperty.html#com.amazon.carbonado.qe">OrderedProperty</a> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableIndex.html#com.amazon.carbonado.qe">StorableIndex</a> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableInfo.html#com.amazon.carbonado.qe">StorableInfo</a> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableKey.html#com.amazon.carbonado.qe">StorableKey</a> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/OrderedProperty.html#com.amazon.carbonado.raw">OrderedProperty</a> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableIndex.html#com.amazon.carbonado.raw">StorableIndex</a> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableProperty.html#com.amazon.carbonado.raw">StorableProperty</a> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableInfo.html#com.amazon.carbonado.repo.jdbc">StorableInfo</a> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableIntrospector.html#com.amazon.carbonado.repo.jdbc">StorableIntrospector</a> +<div class="block">Supports examination of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types, returning all metadata + associated with it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableProperty.html#com.amazon.carbonado.repo.jdbc">StorableProperty</a> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html#com.amazon.carbonado.repo.jdbc">StorablePropertyAdapter</a> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.spi">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.synthetic">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html#com.amazon.carbonado.synthetic">StorablePropertyAdapter</a> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/layout/Layout.html b/apidocs/com/amazon/carbonado/layout/Layout.html new file mode 100644 index 0000000..284f919 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/Layout.html @@ -0,0 +1,580 @@ +<!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>Layout (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="Layout (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/Layout.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/Layout.html" target="_top">Frames</a></li> +<li><a href="Layout.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.layout</div> +<h2 title="Class Layout" class="title">Class Layout</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.Layout</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Layout</span> +extends java.lang.Object</pre> +<div class="block">Describes the layout of a specific generation of a storable.</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/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><code>LayoutFactory</code></a></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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#equalLayouts(com.amazon.carbonado.layout.Layout)">equalLayouts</a></strong>(<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> +<div class="block">Returns true if the given layout matches this one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Returns all the properties of this layout, in their proper order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.joda.time.DateTime</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getCreationDateTime()">getCreationDateTime</a></strong>()</code> +<div class="block">Returns the date and time for when this layout generation was created.</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/layout/Layout.html#getCreationHost()">getCreationHost</a></strong>()</code> +<div class="block">Returns the host machine that created this generation.</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/layout/Layout.html#getCreationUser()">getCreationUser</a></strong>()</code> +<div class="block">Returns the user that created this layout generation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getDataProperties()">getDataProperties</a></strong>()</code> +<div class="block">Returns all the non-primary key properties of this layout, in their + proper order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getGeneration()">getGeneration</a></strong>()</code> +<div class="block">Returns the generation of this layout, where zero represents the first + generation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getGeneration(int)">getGeneration</a></strong>(int generation)</code> +<div class="block">Returns the layout for a particular generation of this layout's type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getLayoutID()">getLayoutID</a></strong>()</code> +<div class="block">Returns a unique identifier for this layout.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#getOptions()">getOptions</a></strong>()</code> +<div class="block">Returns additional options, or null if none.</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/layout/Layout.html#getStorableTypeName()">getStorableTypeName</a></strong>()</code> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#nextGeneration()">nextGeneration</a></strong>()</code> +<div class="block">Returns the next known generation of the storable's layout, or null + if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#previousGeneration()">previousGeneration</a></strong>()</code> +<div class="block">Returns the previous known generation of the storable's layout, or null + if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#reconstruct()">reconstruct</a></strong>()</code> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#reconstruct(java.lang.ClassLoader)">reconstruct</a></strong>(java.lang.ClassLoader loader)</code> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</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/layout/Layout.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)">writeTo</a></strong>(java.io.OutputStream out)</code> +<div class="block">Write a layout to be read by <a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)"><code>LayoutFactory.readLayoutFrom(java.io.InputStream)</code></a>.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="getLayoutID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLayoutID</h4> +<pre>public long getLayoutID()</pre> +<div class="block">Returns a unique identifier for this layout.</div> +</li> +</ul> +<a name="getStorableTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableTypeName</h4> +<pre>public java.lang.String getStorableTypeName()</pre> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</li> +</ul> +<a name="getGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGeneration</h4> +<pre>public int getGeneration()</pre> +<div class="block">Returns the generation of this layout, where zero represents the first + generation.</div> +</li> +</ul> +<a name="getDataProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataProperties</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>> getDataProperties() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns all the non-primary key properties of this layout, in their + proper order.</div> +<dl><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="getAllProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllProperties</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>> getAllProperties() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns all the properties of this layout, in their proper order.</div> +<dl><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="getCreationDateTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationDateTime</h4> +<pre>public org.joda.time.DateTime getCreationDateTime()</pre> +<div class="block">Returns the date and time for when this layout generation was created.</div> +</li> +</ul> +<a name="getCreationUser()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationUser</h4> +<pre>public java.lang.String getCreationUser()</pre> +<div class="block">Returns the user that created this layout generation.</div> +</li> +</ul> +<a name="getCreationHost()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationHost</h4> +<pre>public java.lang.String getCreationHost()</pre> +<div class="block">Returns the host machine that created this generation.</div> +</li> +</ul> +<a name="getOptions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOptions</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> getOptions()</pre> +<div class="block">Returns additional options, or null if none.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>read-only object or null</dd></dl> +</li> +</ul> +<a name="getGeneration(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGeneration</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> getGeneration(int generation) + throws <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a>, + <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the layout for a particular generation of this layout's type.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if generation not found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="previousGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>previousGeneration</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> previousGeneration() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the previous known generation of the storable's layout, or null + if none.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a layout with a lower generation, or null if none</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="nextGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextGeneration</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> nextGeneration() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the next known generation of the storable's layout, or null + if none.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a layout with a higher generation, or null if none</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="reconstruct()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reconstruct</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> reconstruct() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class. The reconstructed storable type will not contain + everything in the original, but rather the minimum required to decode + persisted instances.</div> +<dl><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> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd></dl> +</li> +</ul> +<a name="reconstruct(java.lang.ClassLoader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reconstruct</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> reconstruct(java.lang.ClassLoader loader) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class. The reconstructed storable type will not contain + everything in the original, but rather the minimum required to decode + persisted instances.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>loader</code> - optional ClassLoader to load reconstruct class into, if it + has not been loaded yet</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> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equalLayouts(com.amazon.carbonado.layout.Layout)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equalLayouts</h4> +<pre>public boolean equalLayouts(<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns true if the given layout matches this one. Layout ID, + generation, and creation info is not considered in the comparison.</div> +<dl><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="writeTo(java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>writeTo</h4> +<pre>public void writeTo(java.io.OutputStream out) + throws java.io.IOException, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Write a layout to be read by <a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)"><code>LayoutFactory.readLayoutFrom(java.io.InputStream)</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</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/Layout.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/Layout.html" target="_top">Frames</a></li> +<li><a href="Layout.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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutCapability.html b/apidocs/com/amazon/carbonado/layout/LayoutCapability.html new file mode 100644 index 0000000..ba50e1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutCapability.html @@ -0,0 +1,253 @@ +<!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>LayoutCapability (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="LayoutCapability (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/LayoutCapability.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/layout/Layout.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutCapability.html" target="_top">Frames</a></li> +<li><a href="LayoutCapability.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.layout</div> +<h2 title="Interface LayoutCapability" class="title">Interface LayoutCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">LayoutCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability to get layout information on any storable generation.</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><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +</table> +</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="layoutFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the layout matching the current definition of the given type.</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 type represents a new generation, but + persisting this information failed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="layoutFor(java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></pre> +<div class="block">Returns the layout for a particular generation of the given type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>generation</code> - desired generation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if generation not found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</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/LayoutCapability.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/layout/Layout.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutCapability.html" target="_top">Frames</a></li> +<li><a href="LayoutCapability.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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutFactory.html b/apidocs/com/amazon/carbonado/layout/LayoutFactory.html new file mode 100644 index 0000000..ea086bc --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutFactory.html @@ -0,0 +1,421 @@ +<!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>LayoutFactory (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="LayoutFactory (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/LayoutFactory.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/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutFactory.html" target="_top">Frames</a></li> +<li><a href="LayoutFactory.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.layout</div> +<h2 title="Class LayoutFactory" class="title">Class LayoutFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.LayoutFactory</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>, <a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">LayoutFactory</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></pre> +<div class="block">Factory for obtaining references to storable layouts.</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"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#VERSION">VERSION</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/layout/LayoutFactory.html#LayoutFactory(com.amazon.carbonado.Repository)">LayoutFactory</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</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/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)">readLayoutFrom</a></strong>(java.io.InputStream in)</code> +<div class="block">Read a layout as written by <a href="../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)"><code>Layout.writeTo(java.io.OutputStream)</code></a>.</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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="VERSION"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>VERSION</h4> +<pre>public static final int VERSION</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.layout.LayoutFactory.VERSION">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LayoutFactory(com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LayoutFactory</h4> +<pre>public LayoutFactory(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><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 underlying repository + does not support the storables for persisting storable layouts</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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="layoutFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the layout matching the current definition of the given type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></code></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> - if type represents a new generation, but + persisting this information failed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the layout matching the current definition of the given type.</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 type represents a new generation, but + persisting this information failed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(boolean readOnly, + java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the layout matching the current definition of the given type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>readOnly</code> - if true, don't attempt to persist new generation because + underlying repository is read-only</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> - if type represents a new generation, but + persisting this information failed</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="layoutFor(java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>layoutFor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layoutFor(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></pre> +<div class="block">Returns the layout for a particular generation of the given type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>generation</code> - desired generation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if generation not found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="readLayoutFrom(java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readLayoutFrom</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> readLayoutFrom(java.io.InputStream in) + throws java.io.IOException, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Read a layout as written by <a href="../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)"><code>Layout.writeTo(java.io.OutputStream)</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</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/LayoutFactory.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/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutFactory.html" target="_top">Frames</a></li> +<li><a href="LayoutFactory.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutOptions.html b/apidocs/com/amazon/carbonado/layout/LayoutOptions.html new file mode 100644 index 0000000..f6e36c3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutOptions.html @@ -0,0 +1,307 @@ +<!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>LayoutOptions (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="LayoutOptions (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/LayoutOptions.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/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutOptions.html" target="_top">Frames</a></li> +<li><a href="LayoutOptions.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><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.layout</div> +<h2 title="Class LayoutOptions" class="title">Class LayoutOptions</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.LayoutOptions</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LayoutOptions</span> +extends java.lang.Object</pre> +<div class="block">Extra options encoded with a Storable layout.</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"> +<!-- ======== 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/layout/LayoutOptions.html#LayoutOptions()">LayoutOptions</a></strong>()</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html#decode(byte[])">decode</a></strong>(byte[] source)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html#encode()">encode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html#getCompressionType()">getCompressionType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html#setCompressionType(java.lang.String)">setCompressionType</a></strong>(java.lang.String type)</code> </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> +</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="LayoutOptions()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LayoutOptions</h4> +<pre>public LayoutOptions()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCompressionType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCompressionType</h4> +<pre>public java.lang.String getCompressionType()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if not compressed</dd></dl> +</li> +</ul> +<a name="setCompressionType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCompressionType</h4> +<pre>public void setCompressionType(java.lang.String type)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - null if not compressed</dd></dl> +</li> +</ul> +<a name="encode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public byte[] encode()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if empty</dd></dl> +</li> +</ul> +<a name="decode(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decode</h4> +<pre>public void decode(byte[] source) + throws java.io.IOException</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - can be null if empty</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/LayoutOptions.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/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutOptions.html" target="_top">Frames</a></li> +<li><a href="LayoutOptions.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><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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutProperty.html b/apidocs/com/amazon/carbonado/layout/LayoutProperty.html new file mode 100644 index 0000000..0acb8be --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutProperty.html @@ -0,0 +1,410 @@ +<!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>LayoutProperty (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="LayoutProperty (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/LayoutProperty.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/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutProperty.html" target="_top">Frames</a></li> +<li><a href="LayoutProperty.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.layout</div> +<h2 title="Class LayoutProperty" class="title">Class LayoutProperty</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.LayoutProperty</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LayoutProperty</span> +extends java.lang.Object</pre> +<div class="block">Describes how a property is defined in a specific generation of a storable.</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/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a></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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#getAdapterParams()">getAdapterParams</a></strong>()</code> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</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/layout/LayoutProperty.html#getAdapterTypeName()">getAdapterTypeName</a></strong>()</code> +<div class="block">Adapter type name is a fully qualified Java class name.</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/layout/LayoutProperty.html#getPropertyName()">getPropertyName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType()">getPropertyType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType(java.lang.ClassLoader)">getPropertyType</a></strong>(java.lang.ClassLoader loader)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyTypeDescriptor()">getPropertyTypeDescriptor</a></strong>()</code> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#isNullable()">isNullable</a></strong>()</code> +<div class="block">Returns true of property can be set to null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember</a></strong>()</code> +<div class="block">Returns true if property is a member of the primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html#isVersion()">isVersion</a></strong>()</code> +<div class="block">Returns true if this property is the designated version number for the + Storable.</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/layout/LayoutProperty.html#toString()">toString</a></strong>()</code> </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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="getPropertyName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyName</h4> +<pre>public java.lang.String getPropertyName()</pre> +</li> +</ul> +<a name="getPropertyTypeDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyTypeDescriptor</h4> +<pre>public java.lang.String getPropertyTypeDescriptor()</pre> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</li> +</ul> +<a name="getPropertyType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyType</h4> +<pre>public java.lang.Class getPropertyType() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><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></dd></dl> +</li> +</ul> +<a name="getPropertyType(java.lang.ClassLoader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyType</h4> +<pre>public java.lang.Class getPropertyType(java.lang.ClassLoader loader) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><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></dd></dl> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>public boolean isNullable()</pre> +<div class="block">Returns true of property can be set to null.</div> +</li> +</ul> +<a name="isPrimaryKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrimaryKeyMember</h4> +<pre>public boolean isPrimaryKeyMember()</pre> +<div class="block">Returns true if property is a member of the primary key.</div> +</li> +</ul> +<a name="isVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersion</h4> +<pre>public boolean isVersion()</pre> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</li> +</ul> +<a name="getAdapterTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterTypeName</h4> +<pre>public java.lang.String getAdapterTypeName()</pre> +<div class="block">Adapter type name is a fully qualified Java class name. If property has + no adapter, then null is returned.</div> +</li> +</ul> +<a name="getAdapterParams()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterParams</h4> +<pre>public java.lang.String getAdapterParams()</pre> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/LayoutProperty.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/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutProperty.html" target="_top">Frames</a></li> +<li><a href="LayoutProperty.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> diff --git a/apidocs/com/amazon/carbonado/layout/LayoutSync.html b/apidocs/com/amazon/carbonado/layout/LayoutSync.html new file mode 100644 index 0000000..c9b784b --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/LayoutSync.html @@ -0,0 +1,268 @@ +<!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>LayoutSync (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="LayoutSync (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/LayoutSync.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/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutSync.html" target="_top">Frames</a></li> +<li><a href="LayoutSync.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><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.layout</div> +<h2 title="Class LayoutSync" class="title">Class LayoutSync</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.layout.LayoutSync</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LayoutSync</span> +extends java.lang.Object</pre> +<div class="block">Synchronizes layout metadata between two repositories. Both source and + destination might be updated.</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"> +<!-- ======== 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/layout/LayoutSync.html#LayoutSync(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LayoutSync</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> source, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> destination)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html#run()">run</a></strong>()</code> </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> +</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="LayoutSync(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LayoutSync</h4> +<pre>public LayoutSync(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> source, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> destination)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="run()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>run</h4> +<pre>public boolean run() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if any changes to source were made</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/LayoutSync.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/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/LayoutSync.html" target="_top">Frames</a></li> +<li><a href="LayoutSync.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><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> diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayout.html b/apidocs/com/amazon/carbonado/layout/StoredLayout.html new file mode 100644 index 0000000..6652179 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayout.html @@ -0,0 +1,456 @@ +<!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>StoredLayout (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="StoredLayout (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/StoredLayout.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/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/StoredLayout.html" target="_top">Frames</a></li> +<li><a href="StoredLayout.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.layout</div> +<h2 title="Interface StoredLayout" class="title">Interface StoredLayout</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/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">@AlternateKeys</a>(<a href="../../../../com/amazon/carbonado/AlternateKeys.html#value()">value</a>=<a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">@Key</a>(<a href="../../../../com/amazon/carbonado/Key.html#value()">value</a>={"storableTypeName","generation"})) +<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>="layoutID") +<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_LAYOUT") +public interface <span class="strong">StoredLayout</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></pre> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>. This interface is public only because + Carbonado requires storable type definitions to be public.</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getCreationHost()">getCreationHost</a></strong>()</code> +<div class="block">Returns the host machine that created this generation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.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="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getCreationUser()">getCreationUser</a></strong>()</code> +<div class="block">Returns the user that created this generation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getGeneration()">getGeneration</a></strong>()</code> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getLayoutID()">getLayoutID</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getStorableTypeName()">getStorableTypeName</a></strong>()</code> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredTypeLayout instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setCreationHost(java.lang.String)">setCreationHost</a></strong>(java.lang.String host)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.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/layout/StoredLayout.html#setCreationUser(java.lang.String)">setCreationUser</a></strong>(java.lang.String user)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setGeneration(int)">setGeneration</a></strong>(int generation)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setLayoutID(long)">setLayoutID</a></strong>(long typeID)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html#setStorableTypeName(java.lang.String)">setStorableTypeName</a></strong>(java.lang.String typeName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayout.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="getLayoutID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLayoutID</h4> +<pre>long getLayoutID()</pre> +</li> +</ul> +<a name="setLayoutID(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLayoutID</h4> +<pre>void setLayoutID(long typeID)</pre> +</li> +</ul> +<a name="getStorableTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableTypeName</h4> +<pre>java.lang.String getStorableTypeName()</pre> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</li> +</ul> +<a name="setStorableTypeName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStorableTypeName</h4> +<pre>void setStorableTypeName(java.lang.String typeName)</pre> +</li> +</ul> +<a name="getGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGeneration</h4> +<pre>int getGeneration()</pre> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</li> +</ul> +<a name="setGeneration(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGeneration</h4> +<pre>void setGeneration(int generation)</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="getCreationUser()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationUser</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getCreationUser()</pre> +<div class="block">Returns the user that created this generation.</div> +</li> +</ul> +<a name="setCreationUser(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCreationUser</h4> +<pre>void setCreationUser(java.lang.String user)</pre> +</li> +</ul> +<a name="getCreationHost()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationHost</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getCreationHost()</pre> +<div class="block">Returns the host machine that created this generation.</div> +</li> +</ul> +<a name="setCreationHost(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCreationHost</h4> +<pre>void setCreationHost(java.lang.String host)</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 StoredTypeLayout 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/StoredLayout.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/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/StoredLayout.html" target="_top">Frames</a></li> +<li><a href="StoredLayout.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> diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html b/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html new file mode 100644 index 0000000..e95aa3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayoutEquivalence.html @@ -0,0 +1,354 @@ +<!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>StoredLayoutEquivalence (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="StoredLayoutEquivalence (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/StoredLayoutEquivalence.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/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/StoredLayoutEquivalence.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutEquivalence.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.layout</div> +<h2 title="Interface StoredLayoutEquivalence" class="title">Interface StoredLayoutEquivalence</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/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</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>={"storableTypeName","generation"}) +<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_LAYOUT_EQUIV") +public interface <span class="strong">StoredLayoutEquivalence</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></pre> +<div class="block">Maps layout generations which are equivalent.</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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getExtraData()">getExtraData</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getGeneration()">getGeneration</a></strong>()</code> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getMatchedGeneration()">getMatchedGeneration</a></strong>()</code> +<div class="block">Generation of matched layout.</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/layout/StoredLayoutEquivalence.html#getStorableTypeName()">getStorableTypeName</a></strong>()</code> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getVersionNumber()">getVersionNumber</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setGeneration(int)">setGeneration</a></strong>(int generation)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setMatchedGeneration(int)">setMatchedGeneration</a></strong>(int generation)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setStorableTypeName(java.lang.String)">setStorableTypeName</a></strong>(java.lang.String typeName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.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="getStorableTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableTypeName</h4> +<pre>java.lang.String getStorableTypeName()</pre> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</li> +</ul> +<a name="setStorableTypeName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStorableTypeName</h4> +<pre>void setStorableTypeName(java.lang.String typeName)</pre> +</li> +</ul> +<a name="getGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGeneration</h4> +<pre>int getGeneration()</pre> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</li> +</ul> +<a name="setGeneration(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setGeneration</h4> +<pre>void setGeneration(int generation)</pre> +</li> +</ul> +<a name="getMatchedGeneration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMatchedGeneration</h4> +<pre>int getMatchedGeneration()</pre> +<div class="block">Generation of matched layout.</div> +</li> +</ul> +<a name="setMatchedGeneration(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMatchedGeneration</h4> +<pre>void setMatchedGeneration(int generation)</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> +</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> +</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/StoredLayoutEquivalence.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/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/StoredLayoutEquivalence.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutEquivalence.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> diff --git a/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html b/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html new file mode 100644 index 0000000..404f05a --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/StoredLayoutProperty.html @@ -0,0 +1,543 @@ +<!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>StoredLayoutProperty (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="StoredLayoutProperty (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/StoredLayoutProperty.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/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/StoredLayoutProperty.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutProperty.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.layout</div> +<h2 title="Interface StoredLayoutProperty" class="title">Interface StoredLayoutProperty</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/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado">@AlternateKeys</a>(<a href="../../../../com/amazon/carbonado/AlternateKeys.html#value()">value</a>=<a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado">@Key</a>(<a href="../../../../com/amazon/carbonado/Key.html#value()">value</a>={"layoutID","propertyName"})) +<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>={"layoutID","ordinal"}) +<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_LAYOUT_PROPERTY") +public interface <span class="strong">StoredLayoutProperty</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a>>, <a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></pre> +<div class="block">Stored property joined to a <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>. This interface is public only because Carbonado + requires storable type definitions to be public.</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getAdapterParams()">getAdapterParams</a></strong>()</code> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</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/layout/StoredLayoutProperty.html#getAdapterTypeName()">getAdapterTypeName</a></strong>()</code> +<div class="block">Adapter type name is a fully qualified Java class name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.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="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getLayoutID()">getLayoutID</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getOrdinal()">getOrdinal</a></strong>()</code> +<div class="block">Ordinal defines the order in which this property appears in it enclosing + layout.</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/layout/StoredLayoutProperty.html#getPropertyName()">getPropertyName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getPropertyTypeDescriptor()">getPropertyTypeDescriptor</a></strong>()</code> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredPropertyLayout instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#isNullable()">isNullable</a></strong>()</code> +<div class="block">Returns true of property value can be set to null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember</a></strong>()</code> +<div class="block">Returns true if property is a member of the primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#isVersion()">isVersion</a></strong>()</code> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setAdapterParams(java.lang.String)">setAdapterParams</a></strong>(java.lang.String params)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setAdapterTypeName(java.lang.String)">setAdapterTypeName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setLayoutID(long)">setLayoutID</a></strong>(long typeID)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setNullable(boolean)">setNullable</a></strong>(boolean nullable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setOrdinal(int)">setOrdinal</a></strong>(int ordinal)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPrimaryKeyMember(boolean)">setPrimaryKeyMember</a></strong>(boolean pk)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPropertyName(java.lang.String)">setPropertyName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPropertyTypeDescriptor(java.lang.String)">setPropertyTypeDescriptor</a></strong>(java.lang.String type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html#setVersion(boolean)">setVersion</a></strong>(boolean version)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.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="getLayoutID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLayoutID</h4> +<pre>long getLayoutID()</pre> +</li> +</ul> +<a name="setLayoutID(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLayoutID</h4> +<pre>void setLayoutID(long typeID)</pre> +</li> +</ul> +<a name="getOrdinal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdinal</h4> +<pre>int getOrdinal()</pre> +<div class="block">Ordinal defines the order in which this property appears in it enclosing + layout.</div> +</li> +</ul> +<a name="setOrdinal(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOrdinal</h4> +<pre>void setOrdinal(int ordinal)</pre> +</li> +</ul> +<a name="getPropertyName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyName</h4> +<pre>java.lang.String getPropertyName()</pre> +</li> +</ul> +<a name="setPropertyName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertyName</h4> +<pre>void setPropertyName(java.lang.String name)</pre> +</li> +</ul> +<a name="getPropertyTypeDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyTypeDescriptor</h4> +<pre>java.lang.String getPropertyTypeDescriptor()</pre> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</li> +</ul> +<a name="setPropertyTypeDescriptor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertyTypeDescriptor</h4> +<pre>void setPropertyTypeDescriptor(java.lang.String type)</pre> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>boolean isNullable()</pre> +<div class="block">Returns true of property value can be set to null.</div> +</li> +</ul> +<a name="setNullable(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNullable</h4> +<pre>void setNullable(boolean nullable)</pre> +</li> +</ul> +<a name="isPrimaryKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrimaryKeyMember</h4> +<pre>boolean isPrimaryKeyMember()</pre> +<div class="block">Returns true if property is a member of the primary key.</div> +</li> +</ul> +<a name="setPrimaryKeyMember(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPrimaryKeyMember</h4> +<pre>void setPrimaryKeyMember(boolean pk)</pre> +</li> +</ul> +<a name="isVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersion</h4> +<pre>boolean isVersion()</pre> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</li> +</ul> +<a name="setVersion(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersion</h4> +<pre>void setVersion(boolean version)</pre> +</li> +</ul> +<a name="getAdapterTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterTypeName</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getAdapterTypeName()</pre> +<div class="block">Adapter type name is a fully qualified Java class name. If property has + no adapter, then null is returned.</div> +</li> +</ul> +<a name="setAdapterTypeName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAdapterTypeName</h4> +<pre>void setAdapterTypeName(java.lang.String name)</pre> +</li> +</ul> +<a name="getAdapterParams()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterParams</h4> +<pre><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +java.lang.String getAdapterParams()</pre> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</li> +</ul> +<a name="setAdapterParams(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAdapterParams</h4> +<pre>void setAdapterParams(java.lang.String params)</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 StoredPropertyLayout 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/StoredLayoutProperty.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/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/StoredLayoutProperty.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutProperty.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> diff --git a/apidocs/com/amazon/carbonado/layout/Unevolvable.html b/apidocs/com/amazon/carbonado/layout/Unevolvable.html new file mode 100644 index 0000000..f09728d --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/Unevolvable.html @@ -0,0 +1,171 @@ +<!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>Unevolvable (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="Unevolvable (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/Unevolvable.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/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/Unevolvable.html" target="_top">Frames</a></li> +<li><a href="Unevolvable.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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.layout</div> +<h2 title="Interface Unevolvable" class="title">Interface Unevolvable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a>, <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a>, <a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a>, <a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Unevolvable</span></pre> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</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/Unevolvable.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/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/Unevolvable.html" target="_top">Frames</a></li> +<li><a href="Unevolvable.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/Layout.html b/apidocs/com/amazon/carbonado/layout/class-use/Layout.html new file mode 100644 index 0000000..0e91eec --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/Layout.html @@ -0,0 +1,317 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.Layout (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="Uses of Class com.amazon.carbonado.layout.Layout (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><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/Layout.html" target="_top">Frames</a></li> +<li><a href="Layout.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.Layout" class="title">Uses of Class<br>com.amazon.carbonado.layout.Layout</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that return <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/Layout.html#getGeneration(int)">getGeneration</a></strong>(int generation)</code> +<div class="block">Returns the layout for a particular generation of this layout's type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, int)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + int generation)</code> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/Layout.html#nextGeneration()">nextGeneration</a></strong>()</code> +<div class="block">Returns the next known generation of the storable's layout, or null + if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/Layout.html#previousGeneration()">previousGeneration</a></strong>()</code> +<div class="block">Returns the previous known generation of the storable's layout, or null + if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)">readLayoutFrom</a></strong>(java.io.InputStream in)</code> +<div class="block">Read a layout as written by <a href="../../../../../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)"><code>writeTo(java.io.OutputStream)</code></a>.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with parameters of type <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/Layout.html#equalLayouts(com.amazon.carbonado.layout.Layout)">equalLayouts</a></strong>(<a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> +<div class="block">Returns true if the given layout matches this one.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/Layout.html" target="_top">Frames</a></li> +<li><a href="Layout.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html new file mode 100644 index 0000000..0ec261c --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.LayoutCapability (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="Uses of Interface com.amazon.carbonado.layout.LayoutCapability (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><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutCapability.html" target="_top">Frames</a></li> +<li><a href="LayoutCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.LayoutCapability" class="title">Uses of Interface<br>com.amazon.carbonado.layout.LayoutCapability</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that implement <a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></strong></code> +<div class="block">Factory for obtaining references to storable layouts.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutCapability.html" target="_top">Frames</a></li> +<li><a href="LayoutCapability.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html new file mode 100644 index 0000000..ffc230f --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.LayoutFactory (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="Uses of Class com.amazon.carbonado.layout.LayoutFactory (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><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutFactory.html" target="_top">Frames</a></li> +<li><a href="LayoutFactory.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.LayoutFactory" class="title">Uses of Class<br>com.amazon.carbonado.layout.LayoutFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.LayoutFactory</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutFactory.html" target="_top">Frames</a></li> +<li><a href="LayoutFactory.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html new file mode 100644 index 0000000..0a48447 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html @@ -0,0 +1,246 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.LayoutOptions (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="Uses of Class com.amazon.carbonado.layout.LayoutOptions (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><a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutOptions.html" target="_top">Frames</a></li> +<li><a href="LayoutOptions.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.LayoutOptions" class="title">Uses of Class<br>com.amazon.carbonado.layout.LayoutOptions</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that return <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/Layout.html#getOptions()">getOptions</a></strong>()</code> +<div class="block">Returns additional options, or null if none.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> with parameters of type <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(boolean readOnly, + java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></code></td> +<td class="colLast"><span class="strong">LayoutFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Optionally return additional information regarding storable encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutOptions.html" target="_top">Frames</a></li> +<li><a href="LayoutOptions.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html new file mode 100644 index 0000000..c088c4b --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html @@ -0,0 +1,169 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.LayoutProperty (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="Uses of Class com.amazon.carbonado.layout.LayoutProperty (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><a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutProperty.html" target="_top">Frames</a></li> +<li><a href="LayoutProperty.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.LayoutProperty" class="title">Uses of Class<br>com.amazon.carbonado.layout.LayoutProperty</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/Layout.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Returns all the properties of this layout, in their proper order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a>></code></td> +<td class="colLast"><span class="strong">Layout.</span><code><strong><a href="../../../../../com/amazon/carbonado/layout/Layout.html#getDataProperties()">getDataProperties</a></strong>()</code> +<div class="block">Returns all the non-primary key properties of this layout, in their + proper order.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutProperty.html" target="_top">Frames</a></li> +<li><a href="LayoutProperty.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html new file mode 100644 index 0000000..28ca812 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.layout.LayoutSync (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="Uses of Class com.amazon.carbonado.layout.LayoutSync (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><a href="../../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutSync.html" target="_top">Frames</a></li> +<li><a href="LayoutSync.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"> +<h2 title="Uses of Class com.amazon.carbonado.layout.LayoutSync" class="title">Uses of Class<br>com.amazon.carbonado.layout.LayoutSync</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.LayoutSync</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/LayoutSync.html" target="_top">Frames</a></li> +<li><a href="LayoutSync.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html new file mode 100644 index 0000000..15fc3f1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.StoredLayout (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="Uses of Interface com.amazon.carbonado.layout.StoredLayout (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><a href="../../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayout.html" target="_top">Frames</a></li> +<li><a href="StoredLayout.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.StoredLayout" class="title">Uses of Interface<br>com.amazon.carbonado.layout.StoredLayout</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.StoredLayout</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayout.html" target="_top">Frames</a></li> +<li><a href="StoredLayout.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html new file mode 100644 index 0000000..26c05dd --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.StoredLayoutEquivalence (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="Uses of Interface com.amazon.carbonado.layout.StoredLayoutEquivalence (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><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutEquivalence.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.StoredLayoutEquivalence" class="title">Uses of Interface<br>com.amazon.carbonado.layout.StoredLayoutEquivalence</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.StoredLayoutEquivalence</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutEquivalence.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html new file mode 100644 index 0000000..a344a31 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.StoredLayoutProperty (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="Uses of Interface com.amazon.carbonado.layout.StoredLayoutProperty (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><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutProperty.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.StoredLayoutProperty" class="title">Uses of Interface<br>com.amazon.carbonado.layout.StoredLayoutProperty</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.layout.StoredLayoutProperty</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html" target="_top">Frames</a></li> +<li><a href="StoredLayoutProperty.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> diff --git a/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html b/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html new file mode 100644 index 0000000..afa80a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html @@ -0,0 +1,230 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.layout.Unevolvable (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="Uses of Interface com.amazon.carbonado.layout.Unevolvable (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><a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/Unevolvable.html" target="_top">Frames</a></li> +<li><a href="Unevolvable.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"> +<h2 title="Uses of Interface com.amazon.carbonado.layout.Unevolvable" class="title">Uses of Interface<br>com.amazon.carbonado.layout.Unevolvable</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></strong></code> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></strong></code> +<div class="block">Maps layout generations which are equivalent.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></strong></code> +<div class="block">Stored property joined to a <a href="../../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></strong></code> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that implement <a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></strong></code> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/layout/class-use/Unevolvable.html" target="_top">Frames</a></li> +<li><a href="Unevolvable.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> diff --git a/apidocs/com/amazon/carbonado/layout/package-frame.html b/apidocs/com/amazon/carbonado/layout/package-frame.html new file mode 100644 index 0000000..58eea25 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-frame.html @@ -0,0 +1,32 @@ +<!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.layout (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/layout/package-summary.html" target="classFrame">com.amazon.carbonado.layout</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="LayoutCapability.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>LayoutCapability</i></a></li> +<li><a href="StoredLayout.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>StoredLayout</i></a></li> +<li><a href="StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>StoredLayoutEquivalence</i></a></li> +<li><a href="StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>StoredLayoutProperty</i></a></li> +<li><a href="Unevolvable.html" title="interface in com.amazon.carbonado.layout" target="classFrame"><i>Unevolvable</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="Layout.html" title="class in com.amazon.carbonado.layout" target="classFrame">Layout</a></li> +<li><a href="LayoutFactory.html" title="class in com.amazon.carbonado.layout" target="classFrame">LayoutFactory</a></li> +<li><a href="LayoutOptions.html" title="class in com.amazon.carbonado.layout" target="classFrame">LayoutOptions</a></li> +<li><a href="LayoutProperty.html" title="class in com.amazon.carbonado.layout" target="classFrame">LayoutProperty</a></li> +<li><a href="LayoutSync.html" title="class in com.amazon.carbonado.layout" target="classFrame">LayoutSync</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/layout/package-summary.html b/apidocs/com/amazon/carbonado/layout/package-summary.html new file mode 100644 index 0000000..c5bca9a --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-summary.html @@ -0,0 +1,230 @@ +<!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.layout (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.layout (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><a href="../../../../com/amazon/carbonado/info/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/lob/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/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.layout</h1> +<div class="docSummary"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</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/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></td> +<td class="colLast"> +<div class="block">Capability to get layout information on any storable generation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></td> +<td class="colLast"> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></td> +<td class="colLast"> +<div class="block">Maps layout generations which are equivalent.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></td> +<td class="colLast"> +<div class="block">Stored property joined to a <a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a></td> +<td class="colLast"> +<div class="block">Marker interface for storables that are not allowed to evolve.</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/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></td> +<td class="colLast"> +<div class="block">Describes the layout of a specific generation of a storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></td> +<td class="colLast"> +<div class="block">Factory for obtaining references to storable layouts.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></td> +<td class="colLast"> +<div class="block">Extra options encoded with a Storable layout.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></td> +<td class="colLast"> +<div class="block">Describes how a property is defined in a specific generation of a storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout">LayoutSync</a></td> +<td class="colLast"> +<div class="block">Synchronizes layout metadata between two repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.layout Description">Package com.amazon.carbonado.layout Description</h2> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories. This allows storable's to evolve. Enough information + is recorded in the <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>layout</code></a> such + that an older generation can be reconstructed, allowing it to be decoded + from persistent storage. + + <p>A storable generation is different than a storable <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a>. The version increases with each + update of an <i>instance</i>, whereas the generation increases when the + storable type definition changes. The version number is stored with each + instance, and the generation is stored via the classes in this package. + + <p>Whenever a property is added or removed from a storable, the storable + layout is assigned a new generation value. If the storable layout reverts to + a previous generation's layout, no new generation value is created. Instead, + the generation value of the current storable will match the previous + generation.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><code>LayoutFactory</code></a></dd></dl> +</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><a href="../../../../com/amazon/carbonado/info/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/lob/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/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> diff --git a/apidocs/com/amazon/carbonado/layout/package-tree.html b/apidocs/com/amazon/carbonado/layout/package-tree.html new file mode 100644 index 0000000..3255207 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-tree.html @@ -0,0 +1,156 @@ +<!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.layout Class Hierarchy (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.layout Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/info/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/lob/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.layout</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><span class="strong">Layout</span></a></li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutFactory</span></a> (implements com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutOptions</span></a></li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutProperty</span></a></li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutSync</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">LayoutCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayout</span></a> (also extends com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutEquivalence</span></a> (also extends com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutProperty</span></a> (also extends com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Unevolvable</span></a> +<ul> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayout</span></a> (also extends com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutEquivalence</span></a> (also extends com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutProperty</span></a> (also extends com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/info/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/lob/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/layout/package-use.html b/apidocs/com/amazon/carbonado/layout/package-use.html new file mode 100644 index 0000000..a42c9f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/package-use.html @@ -0,0 +1,252 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.layout (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="Uses of Package com.amazon.carbonado.layout (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.layout" class="title">Uses of Package<br>com.amazon.carbonado.layout</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> used by <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Layout.html#com.amazon.carbonado.layout">Layout</a> +<div class="block">Describes the layout of a specific generation of a storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/LayoutCapability.html#com.amazon.carbonado.layout">LayoutCapability</a> +<div class="block">Capability to get layout information on any storable generation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/LayoutOptions.html#com.amazon.carbonado.layout">LayoutOptions</a> +<div class="block">Extra options encoded with a Storable layout.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/LayoutProperty.html#com.amazon.carbonado.layout">LayoutProperty</a> +<div class="block">Describes how a property is defined in a specific generation of a storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Unevolvable.html#com.amazon.carbonado.layout">Unevolvable</a> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Layout.html#com.amazon.carbonado.raw">Layout</a> +<div class="block">Describes the layout of a specific generation of a storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/LayoutOptions.html#com.amazon.carbonado.raw">LayoutOptions</a> +<div class="block">Extra options encoded with a Storable layout.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> used by <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Unevolvable.html#com.amazon.carbonado.repo.indexed">Unevolvable</a> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> used by <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/layout/class-use/Unevolvable.html#com.amazon.carbonado.repo.sleepycat">Unevolvable</a> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/layout/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/lob/AbstractBlob.html b/apidocs/com/amazon/carbonado/lob/AbstractBlob.html new file mode 100644 index 0000000..0764636 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/AbstractBlob.html @@ -0,0 +1,523 @@ +<!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>AbstractBlob (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="AbstractBlob (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/AbstractBlob.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/AbstractBlob.html" target="_top">Frames</a></li> +<li><a href="AbstractBlob.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><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.lob</div> +<h2 title="Class AbstractBlob" class="title">Class AbstractBlob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.AbstractBlob</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/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a>, <a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractBlob</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></pre> +<div class="block">AbstractBlob implements a small set of common Blob methods.</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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#AbstractBlob()">AbstractBlob</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#AbstractBlob(com.amazon.carbonado.Repository)">AbstractBlob</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</code> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction.</div> +</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.</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/lob/AbstractBlob.html#asString(java.nio.charset.Charset)">asString</a></strong>(java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</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/lob/AbstractBlob.html#asString(java.lang.String)">asString</a></strong>(java.lang.String charsetName)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a></strong>(java.lang.String value, + java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.lang.String)">setValue</a></strong>(java.lang.String value, + java.lang.String charsetName)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</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/lob/AbstractBlob.html#toString()">toString</a></strong>()</code> </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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Blob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Blob.html#getLength()">getLength</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream()">openInputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">openInputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">openInputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">openOutputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">openOutputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">openOutputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#setLength(long)">setLength</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Lob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator</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="AbstractBlob()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AbstractBlob</h4> +<pre>protected AbstractBlob()</pre> +</li> +</ul> +<a name="AbstractBlob(com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractBlob</h4> +<pre>protected AbstractBlob(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</pre> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction. A Repository is passed in for entering the transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - optional repository to use for performing string conversion + within transactions</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="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString() + 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/lob/Blob.html#asString()">Blob</a></code></strong></div> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding. Call within a transaction scope to ensure the + data does not change while the String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString()">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</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></dl> +</li> +</ul> +<a name="asString(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString(java.lang.String charsetName) + 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/lob/Blob.html#asString(java.lang.String)">Blob</a></code></strong></div> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.lang.String)">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>charsetName</code> - name of character set to decode String</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="asString(java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString(java.nio.charset.Charset charset) + 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/lob/Blob.html#asString(java.nio.charset.Charset)">Blob</a></code></strong></div> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.nio.charset.Charset)">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>charset</code> - character set to decode String</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="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public void setValue(java.lang.String value) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String)">Blob</a></code></strong></div> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding. The Blob length may grow or shrink, to + match the encoded String value. Call within a transaction scope to + ensure the data and length does not change while the value is set.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</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="setValue(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public void setValue(java.lang.String value, + java.lang.String charsetName) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.lang.String)">Blob</a></code></strong></div> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.lang.String)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</dd><dd><code>charsetName</code> - name of character set to encode String</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="setValue(java.lang.String, java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public void setValue(java.lang.String value, + java.nio.charset.Charset charset) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.nio.charset.Charset)">Blob</a></code></strong></div> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</dd><dd><code>charset</code> - character set to encode String</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="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">Lob</a></code></strong></div> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/AbstractBlob.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/AbstractBlob.html" target="_top">Frames</a></li> +<li><a href="AbstractBlob.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><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> diff --git a/apidocs/com/amazon/carbonado/lob/AbstractClob.html b/apidocs/com/amazon/carbonado/lob/AbstractClob.html new file mode 100644 index 0000000..75110e3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/AbstractClob.html @@ -0,0 +1,406 @@ +<!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>AbstractClob (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="AbstractClob (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/AbstractClob.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/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/AbstractClob.html" target="_top">Frames</a></li> +<li><a href="AbstractClob.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><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.lob</div> +<h2 title="Class AbstractClob" class="title">Class AbstractClob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.AbstractClob</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/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a>, <a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a>, <a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractClob</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></pre> +<div class="block">AbstractClob implements a small set of common Clob methods.</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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#AbstractClob()">AbstractClob</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#AbstractClob(com.amazon.carbonado.Repository)">AbstractClob</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</code> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction.</div> +</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Clob data as a single String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String.</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/lob/AbstractClob.html#toString()">toString</a></strong>()</code> </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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Clob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">getLength</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">openReader</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">openReader</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">openReader</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">openWriter</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">openWriter</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">openWriter</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">setLength</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Lob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator</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="AbstractClob()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AbstractClob</h4> +<pre>protected AbstractClob()</pre> +</li> +</ul> +<a name="AbstractClob(com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractClob</h4> +<pre>protected AbstractClob(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</pre> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction. A Repository is passed in for entering the transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - optional repository to use for performing string conversion + within transactions</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="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString() + 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/lob/Clob.html#asString()">Clob</a></code></strong></div> +<div class="block">Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</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></dl> +</li> +</ul> +<a name="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public void setValue(java.lang.String value) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">Clob</a></code></strong></div> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String. The Clob length may grow or shrink, to match the String + value. Call within a transaction scope to ensure the data and length + does not change while the value is set.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Clob is overwritten with this value</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="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">Lob</a></code></strong></div> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/AbstractClob.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/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/AbstractClob.html" target="_top">Frames</a></li> +<li><a href="AbstractClob.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><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> diff --git a/apidocs/com/amazon/carbonado/lob/Blob.html b/apidocs/com/amazon/carbonado/lob/Blob.html new file mode 100644 index 0000000..40d1dc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Blob.html @@ -0,0 +1,564 @@ +<!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>Blob (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="Blob (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/Blob.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/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/Blob.html" target="_top">Frames</a></li> +<li><a href="Blob.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.lob</div> +<h2 title="Interface Blob" class="title">Interface Blob</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/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a>, <a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a>, <a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Blob</span> +extends <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></pre> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects. Consider accessing + Blobs within a <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><code>transaction</code></a> scope, + to prevent unexpected updates.</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/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clob</code></a></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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.</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/lob/Blob.html#asString(java.nio.charset.Charset)">asString</a></strong>(java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</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/lob/Blob.html#asString(java.lang.String)">asString</a></strong>(java.lang.String charsetName)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream()">openInputStream</a></strong>()</code> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">openInputStream</a></strong>(long pos)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">openInputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">openOutputStream</a></strong>()</code> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">openOutputStream</a></strong>(long pos)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">openOutputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a></strong>(java.lang.String value, + java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.lang.String)">setValue</a></strong>(java.lang.String value, + java.lang.String charsetName)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Lob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator</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="openInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>java.io.InputStream openInputStream() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openInputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>java.io.InputStream openInputStream(long pos) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openInputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>java.io.InputStream openInputStream(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd><dd><code>bufferSize</code> - suggest that the input stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>long getLength() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the length of this Blob, in bytes.</div> +<dl><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="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>java.lang.String asString() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding. Call within a transaction scope to ensure the + data does not change while the String is being built.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if resulting String length would be + greater than Integer.MAX_VALUE</dd> +<dd><code>java.lang.OutOfMemoryError</code> - if not enough memory to hold Blob as a single String</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="asString(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>java.lang.String asString(java.lang.String charsetName) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charsetName</code> - name of character set to decode String</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.nio.charset.IllegalCharsetNameException</code> - if the given charset name is illegal</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if resulting String length would be + greater than Integer.MAX_VALUE</dd> +<dd><code>java.lang.OutOfMemoryError</code> - if not enough memory to hold Blob as a single String</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="asString(java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>java.lang.String asString(java.nio.charset.Charset charset) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charset</code> - character set to decode String</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if resulting String length would be + greater than Integer.MAX_VALUE</dd> +<dd><code>java.lang.OutOfMemoryError</code> - if not enough memory to hold Blob as a single String</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openOutputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>java.io.OutputStream openOutputStream() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="openOutputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>java.io.OutputStream openOutputStream(long pos) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="openOutputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>java.io.OutputStream openOutputStream(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd><dd><code>bufferSize</code> - suggest that the output stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - new length to set to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if length is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Blob is read-only</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>void setValue(java.lang.String value) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding. The Blob length may grow or shrink, to + match the encoded String value. Call within a transaction scope to + ensure the data and length does not change while the value is set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if value is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setValue(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>void setValue(java.lang.String value, + java.lang.String charsetName) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</dd><dd><code>charsetName</code> - name of character set to encode String</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.nio.charset.IllegalCharsetNameException</code> - if the given charset name is illegal</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if value is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setValue(java.lang.String, java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setValue</h4> +<pre>void setValue(java.lang.String value, + java.nio.charset.Charset charset) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</dd><dd><code>charset</code> - character set to encode String</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if value is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</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/Blob.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/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/Blob.html" target="_top">Frames</a></li> +<li><a href="Blob.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> diff --git a/apidocs/com/amazon/carbonado/lob/BlobClob.html b/apidocs/com/amazon/carbonado/lob/BlobClob.html new file mode 100644 index 0000000..2b0adc3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/BlobClob.html @@ -0,0 +1,482 @@ +<!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>BlobClob (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="BlobClob (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/BlobClob.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/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/BlobClob.html" target="_top">Frames</a></li> +<li><a href="BlobClob.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><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.lob</div> +<h2 title="Class BlobClob" class="title">Class BlobClob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractClob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.BlobClob</li> +</ul> +</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/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">BlobClob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></pre> +<div class="block">A Clob implementation which is backed by a Blob. Data is stored in the Blob + using UTF-16BE encoding.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Bob Loblaw</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/lob/BlobClob.html#BlobClob(com.amazon.carbonado.lob.Blob)">BlobClob</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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/lob/BlobClob.html#getWrappedBlob()">getWrappedBlob</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openReader()">openReader</a></strong>()</code> +<div class="block">Returns a Reader for reading Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openReader(long, int)">openReader</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openWriter()">openWriter</a></strong>()</code> +<div class="block">Returns a Writer for writing Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openWriter(long, int)">openWriter</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Clob, in characters.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractClob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="BlobClob(com.amazon.carbonado.lob.Blob)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BlobClob</h4> +<pre>public BlobClob(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blob</code> - blob to wrap</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="openReader()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader() + 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/lob/Clob.html#openReader()">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</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="openReader(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader(long pos) + 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/lob/Clob.html#openReader(long)">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</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="openReader(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader(long pos, + int bufferSize) + 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/lob/Clob.html#openReader(long, int)">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd><dd><code>bufferSize</code> - suggest that the reader buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</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="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength() + 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/lob/Clob.html#getLength()">Clob</a></code></strong></div> +<div class="block">Returns the length of this Clob, in characters.</div> +<dl><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="openWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</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="openWriter(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter(long pos) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</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="openWriter(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd><dd><code>bufferSize</code> - suggest that the writer buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</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="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">Clob</a></code></strong></div> +<div class="block">Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - new length to set to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Clob is read-only</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">Lob</a></code></strong></div> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +</li> +</ul> +<a name="getWrappedBlob()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getWrappedBlob</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> getWrappedBlob()</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/BlobClob.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/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/BlobClob.html" target="_top">Frames</a></li> +<li><a href="BlobClob.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><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> diff --git a/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html b/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html new file mode 100644 index 0000000..0a3f8be --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html @@ -0,0 +1,487 @@ +<!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>ByteArrayBlob (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="ByteArrayBlob (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/ByteArrayBlob.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/lob/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/ByteArrayBlob.html" target="_top">Frames</a></li> +<li><a href="ByteArrayBlob.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><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.lob</div> +<h2 title="Class ByteArrayBlob" class="title">Class ByteArrayBlob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractBlob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.ByteArrayBlob</li> +</ul> +</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/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ByteArrayBlob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></pre> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</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"> +<!-- ======== 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/lob/ByteArrayBlob.html#ByteArrayBlob(byte[])">ByteArrayBlob</a></strong>(byte[] data)</code> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#ByteArrayBlob(byte[], int)">ByteArrayBlob</a></strong>(byte[] data, + int length)</code> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#ByteArrayBlob(int)">ByteArrayBlob</a></strong>(int capacity)</code> +<div class="block">Construct a ByteArrayBlob with the given initial capacity.</div> +</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream()">openInputStream</a></strong>()</code> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream(long)">openInputStream</a></strong>(long pos)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream(long, int)">openInputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream()">openOutputStream</a></strong>()</code> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream(long)">openOutputStream</a></strong>(long pos)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream(long, int)">openOutputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Blob, in bytes.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractBlob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString()">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.nio.charset.Charset)">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.lang.String)">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="ByteArrayBlob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ByteArrayBlob</h4> +<pre>public ByteArrayBlob(int capacity)</pre> +<div class="block">Construct a ByteArrayBlob with the given initial capacity.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capacity</code> - initial capacity of internal byte array</dd></dl> +</li> +</ul> +<a name="ByteArrayBlob(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ByteArrayBlob</h4> +<pre>public ByteArrayBlob(byte[] data)</pre> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array. The + byte array is not cloned until this ByteArrayBlob grows or shrinks.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - initial data backing the Blob</dd></dl> +</li> +</ul> +<a name="ByteArrayBlob(byte[], int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ByteArrayBlob</h4> +<pre>public ByteArrayBlob(byte[] data, + int length)</pre> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array. The + byte array is not cloned until this ByteArrayBlob grows or shrinks.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - initial data backing the Blob</dd><dd><code>length</code> - initial length of data</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="openInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream()">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openInputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream(long pos)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openInputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream(long pos, + int bufferSize)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd><dd><code>bufferSize</code> - suggest that the input stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#getLength()">Blob</a></code></strong></div> +<div class="block">Returns the length of this Blob, in bytes.</div> +</li> +</ul> +<a name="openOutputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openOutputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream(long pos)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openOutputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream(long pos, + int bufferSize)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd><dd><code>bufferSize</code> - suggest that the output stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setLength(long)">Blob</a></code></strong></div> +<div class="block">Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - new length to set to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Blob is read-only</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block">Always returns null.</div> +</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/ByteArrayBlob.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/lob/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/ByteArrayBlob.html" target="_top">Frames</a></li> +<li><a href="ByteArrayBlob.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><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> diff --git a/apidocs/com/amazon/carbonado/lob/CharArrayClob.html b/apidocs/com/amazon/carbonado/lob/CharArrayClob.html new file mode 100644 index 0000000..7e24d4a --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/CharArrayClob.html @@ -0,0 +1,509 @@ +<!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>CharArrayClob (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="CharArrayClob (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/CharArrayClob.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/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/CharArrayClob.html" target="_top">Frames</a></li> +<li><a href="CharArrayClob.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><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.lob</div> +<h2 title="Class CharArrayClob" class="title">Class CharArrayClob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractClob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.CharArrayClob</li> +</ul> +</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/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">CharArrayClob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></pre> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</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"> +<!-- ======== 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/lob/CharArrayClob.html#CharArrayClob(char[])">CharArrayClob</a></strong>(char[] data)</code> +<div class="block">Construct a CharArrayClob initially backed by the given character array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#CharArrayClob(char[], int)">CharArrayClob</a></strong>(char[] data, + int length)</code> +<div class="block">Construct a CharArrayClob initially backed by the given character array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#CharArrayClob(int)">CharArrayClob</a></strong>(int capacity)</code> +<div class="block">Construct a CharArrayClob with the given initial capacity.</div> +</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Clob data as a single String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#openReader()">openReader</a></strong>()</code> +<div class="block">Returns a Reader for reading Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#openReader(long, int)">openReader</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#openWriter()">openWriter</a></strong>()</code> +<div class="block">Returns a Writer for writing Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#openWriter(long, int)">openWriter</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Clob, in characters.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractClob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="CharArrayClob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CharArrayClob</h4> +<pre>public CharArrayClob(int capacity)</pre> +<div class="block">Construct a CharArrayClob with the given initial capacity.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capacity</code> - initial capacity of internal character array</dd></dl> +</li> +</ul> +<a name="CharArrayClob(char[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CharArrayClob</h4> +<pre>public CharArrayClob(char[] data)</pre> +<div class="block">Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - initial data backing the Clob</dd></dl> +</li> +</ul> +<a name="CharArrayClob(char[], int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CharArrayClob</h4> +<pre>public CharArrayClob(char[] data, + int length)</pre> +<div class="block">Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - initial data backing the Clob</dd><dd><code>length</code> - initial length of data</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="openReader()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openReader(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader(long pos)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openReader(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader(long pos, + int bufferSize)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd><dd><code>bufferSize</code> - suggest that the reader buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">Clob</a></code></strong></div> +<div class="block">Returns the length of this Clob, in characters.</div> +</li> +</ul> +<a name="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">Clob</a></code></strong></div> +<div class="block">Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString</a></code> in class <code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></code></dd> +</dl> +</li> +</ul> +<a name="openWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openWriter(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter(long pos)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openWriter(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter(long pos, + int bufferSize)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd><dd><code>bufferSize</code> - suggest that the writer buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">Clob</a></code></strong></div> +<div class="block">Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - new length to set to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Clob is read-only</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block">Always returns null.</div> +</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/CharArrayClob.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/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/CharArrayClob.html" target="_top">Frames</a></li> +<li><a href="CharArrayClob.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><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> diff --git a/apidocs/com/amazon/carbonado/lob/Clob.html b/apidocs/com/amazon/carbonado/lob/Clob.html new file mode 100644 index 0000000..f2e49a0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Clob.html @@ -0,0 +1,447 @@ +<!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>Clob (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="Clob (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/Clob.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/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/Clob.html" target="_top">Frames</a></li> +<li><a href="Clob.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.lob</div> +<h2 title="Interface Clob" class="title">Interface Clob</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/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a>, <a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a>, <a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a>, <a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Clob</span> +extends <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></pre> +<div class="block">Provides access to CLOBs, which are Character Large OBjects. Consider + accessing Clobs within a <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><code>transaction</code></a> scope, to prevent unexpected updates.</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/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blob</code></a></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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Clob data as a single String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">openReader</a></strong>()</code> +<div class="block">Returns a Reader for reading Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">openReader</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">openWriter</a></strong>()</code> +<div class="block">Returns a Writer for writing Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">openWriter</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Lob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator</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="openReader()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>java.io.Reader openReader() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openReader(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>java.io.Reader openReader(long pos) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openReader(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>java.io.Reader openReader(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd><dd><code>bufferSize</code> - suggest that the reader buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>long getLength() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the length of this Clob, in characters.</div> +<dl><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="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>java.lang.String asString() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if Clob length is greater than Integer.MAX_VALUE</dd> +<dd><code>java.lang.OutOfMemoryError</code> - if not enough memory to hold Clob as a single String</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>java.io.Writer openWriter() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="openWriter(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>java.io.Writer openWriter(long pos) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="openWriter(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>java.io.Writer openWriter(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd><dd><code>bufferSize</code> - suggest that the writer buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - new length to set to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if length is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Clob is read-only</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setValue</h4> +<pre>void setValue(java.lang.String value) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String. The Clob length may grow or shrink, to match the String + value. Call within a transaction scope to ensure the data and length + does not change while the value is set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Clob is overwritten with this value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if value is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</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/Clob.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/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/Clob.html" target="_top">Frames</a></li> +<li><a href="Clob.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> diff --git a/apidocs/com/amazon/carbonado/lob/FileBlob.html b/apidocs/com/amazon/carbonado/lob/FileBlob.html new file mode 100644 index 0000000..4f41f03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/FileBlob.html @@ -0,0 +1,468 @@ +<!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>FileBlob (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="FileBlob (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/FileBlob.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/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/FileBlob.html" target="_top">Frames</a></li> +<li><a href="FileBlob.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><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.lob</div> +<h2 title="Class FileBlob" class="title">Class FileBlob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractBlob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.FileBlob</li> +</ul> +</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/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FileBlob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></pre> +<div class="block">Implementation of a Blob which is backed by a File.</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"> +<!-- ======== 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/lob/FileBlob.html#FileBlob(java.io.File)">FileBlob</a></strong>(java.io.File file)</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream()">openInputStream</a></strong>()</code> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream(long)">openInputStream</a></strong>(long pos)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream(long, int)">openInputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream()">openOutputStream</a></strong>()</code> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream(long)">openOutputStream</a></strong>(long pos)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream(long, int)">openOutputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Blob, in bytes.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractBlob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString()">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.nio.charset.Charset)">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.lang.String)">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="FileBlob(java.io.File)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileBlob</h4> +<pre>public FileBlob(java.io.File file)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="openInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream() + 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/lob/Blob.html#openInputStream()">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</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="openInputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream(long pos) + 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/lob/Blob.html#openInputStream(long)">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</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="openInputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream(long pos, + int bufferSize) + 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/lob/Blob.html#openInputStream(long, int)">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd><dd><code>bufferSize</code> - suggest that the input stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</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="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength() + 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/lob/Blob.html#getLength()">Blob</a></code></strong></div> +<div class="block">Returns the length of this Blob, in bytes.</div> +<dl><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="openOutputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</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="openOutputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream(long pos) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</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="openOutputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd><dd><code>bufferSize</code> - suggest that the output stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</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="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setLength(long)">Blob</a></code></strong></div> +<div class="block">Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - new length to set to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Blob is read-only</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block">Always returns null.</div> +</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/FileBlob.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/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/FileBlob.html" target="_top">Frames</a></li> +<li><a href="FileBlob.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><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> diff --git a/apidocs/com/amazon/carbonado/lob/Lob.html b/apidocs/com/amazon/carbonado/lob/Lob.html new file mode 100644 index 0000000..69e3d8e --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Lob.html @@ -0,0 +1,249 @@ +<!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>Lob (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="Lob (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/Lob.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/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/Lob.html" target="_top">Frames</a></li> +<li><a href="Lob.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.lob</div> +<h2 title="Interface Lob" class="title">Interface Lob</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a>, <a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a>, <a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a>, <a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a>, <a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a>, <a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Lob</span></pre> +<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +</td> +</tr> +</table> +</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="getLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>java.lang.Object getLocator()</pre> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>boolean equals(java.lang.Object obj)</pre> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</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/Lob.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/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/Lob.html" target="_top">Frames</a></li> +<li><a href="Lob.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> diff --git a/apidocs/com/amazon/carbonado/lob/StringClob.html b/apidocs/com/amazon/carbonado/lob/StringClob.html new file mode 100644 index 0000000..6a2a54e --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/StringClob.html @@ -0,0 +1,516 @@ +<!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>StringClob (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="StringClob (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/StringClob.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/lob/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/StringClob.html" target="_top">Frames</a></li> +<li><a href="StringClob.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><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.lob</div> +<h2 title="Class StringClob" class="title">Class StringClob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractClob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.StringClob</li> +</ul> +</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/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StringClob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></pre> +<div class="block">Implementation of a Clob which is backed by a read-only String.</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"> +<!-- ======== 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/lob/StringClob.html#StringClob(java.lang.String)">StringClob</a></strong>(java.lang.String str)</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Clob data as a single String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openReader()">openReader</a></strong>()</code> +<div class="block">Returns a Reader for reading Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openReader(long, int)">openReader</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openWriter()">openWriter</a></strong>()</code> +<div class="block">Returns a Writer for writing Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openWriter(long, int)">openWriter</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractClob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="StringClob(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StringClob</h4> +<pre>public StringClob(java.lang.String str)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="openReader()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openReader(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader(long pos) + 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/lob/Clob.html#openReader(long)">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</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="openReader(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader(long pos, + int bufferSize) + 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/lob/Clob.html#openReader(long, int)">Clob</a></code></strong></div> +<div class="block">Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd><dd><code>bufferSize</code> - suggest that the reader buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</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="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength() + 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/lob/Clob.html#getLength()">Clob</a></code></strong></div> +<div class="block">Returns the length of this Clob, in characters.</div> +<dl><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="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">Clob</a></code></strong></div> +<div class="block">Convenience method to capture all the Clob data as a single String. Call + within a transaction scope to ensure the data does not change while the + String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString</a></code> in class <code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></code></dd> +</dl> +</li> +</ul> +<a name="openWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</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="openWriter(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter(long pos) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</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="openWriter(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">Clob</a></code></strong></div> +<div class="block">Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd><dd><code>bufferSize</code> - suggest that the writer buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</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="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">Clob</a></code></strong></div> +<div class="block">Set the length of this Clob, in characters. If the new length is + shorter, the Clob is truncated. If the new length is longer, the Clob is + padded with '\0' characters.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - new length to set to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Clob is read-only</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public void setValue(java.lang.String value) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">Clob</a></code></strong></div> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String. The Clob length may grow or shrink, to match the String + value. Call within a transaction scope to ensure the data and length + does not change while the value is set.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue</a></code> in class <code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Clob is overwritten with this value</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="getLocator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block">Always returns null.</div> +</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/StringClob.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/lob/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/StringClob.html" target="_top">Frames</a></li> +<li><a href="StringClob.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><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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html new file mode 100644 index 0000000..c426a4c --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.AbstractBlob (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="Uses of Class com.amazon.carbonado.lob.AbstractBlob (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><a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/AbstractBlob.html" target="_top">Frames</a></li> +<li><a href="AbstractBlob.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"> +<h2 title="Uses of Class com.amazon.carbonado.lob.AbstractBlob" class="title">Uses of Class<br>com.amazon.carbonado.lob.AbstractBlob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/AbstractBlob.html" target="_top">Frames</a></li> +<li><a href="AbstractBlob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html b/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html new file mode 100644 index 0000000..9764bbe --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html @@ -0,0 +1,174 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.AbstractClob (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="Uses of Class com.amazon.carbonado.lob.AbstractClob (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><a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/AbstractClob.html" target="_top">Frames</a></li> +<li><a href="AbstractClob.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"> +<h2 title="Uses of Class com.amazon.carbonado.lob.AbstractClob" class="title">Uses of Class<br>com.amazon.carbonado.lob.AbstractClob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></strong></code> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/AbstractClob.html" target="_top">Frames</a></li> +<li><a href="AbstractClob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Blob.html b/apidocs/com/amazon/carbonado/lob/class-use/Blob.html new file mode 100644 index 0000000..9419f63 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Blob.html @@ -0,0 +1,379 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.lob.Blob (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="Uses of Interface com.amazon.carbonado.lob.Blob (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><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Blob.html" target="_top">Frames</a></li> +<li><a href="Blob.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"> +<h2 title="Uses of Interface com.amazon.carbonado.lob.Blob" class="title">Uses of Interface<br>com.amazon.carbonado.lob.Blob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToBlob(java.lang.String)">adaptToBlob</a></strong>(java.lang.String text)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Blob)">adaptToString</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that implement <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></strong></code> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html#getWrappedBlob()">getWrappedBlob</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html#BlobClob(com.amazon.carbonado.lob.Blob)">BlobClob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">RawSupport.</span><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> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertBlob(java.sql.Blob, com.amazon.carbonado.repo.jdbc.JDBCBlobLoader)">convertBlob</a></strong>(java.sql.Blob blob, + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a> loader)</code> </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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setBlobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setBlobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateBlob(com.amazon.carbonado.lob.Blob, com.amazon.carbonado.lob.Blob)">updateBlob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> oldBlob, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> newBlob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#createNewBlob(int)">createNewBlob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Blob whose length is zero.</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"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#getBlobValue(long)">getBlobValue</a></strong>(long locator)</code> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(long locator, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Blob.html" target="_top">Frames</a></li> +<li><a href="Blob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html b/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html new file mode 100644 index 0000000..258d0b0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.BlobClob (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="Uses of Class com.amazon.carbonado.lob.BlobClob (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><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/BlobClob.html" target="_top">Frames</a></li> +<li><a href="BlobClob.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"> +<h2 title="Uses of Class com.amazon.carbonado.lob.BlobClob" class="title">Uses of Class<br>com.amazon.carbonado.lob.BlobClob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.BlobClob</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/BlobClob.html" target="_top">Frames</a></li> +<li><a href="BlobClob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html new file mode 100644 index 0000000..955f5b9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.ByteArrayBlob (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="Uses of Class com.amazon.carbonado.lob.ByteArrayBlob (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><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/ByteArrayBlob.html" target="_top">Frames</a></li> +<li><a href="ByteArrayBlob.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"> +<h2 title="Uses of Class com.amazon.carbonado.lob.ByteArrayBlob" class="title">Uses of Class<br>com.amazon.carbonado.lob.ByteArrayBlob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.ByteArrayBlob</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/ByteArrayBlob.html" target="_top">Frames</a></li> +<li><a href="ByteArrayBlob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html b/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html new file mode 100644 index 0000000..1b6cadf --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.CharArrayClob (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="Uses of Class com.amazon.carbonado.lob.CharArrayClob (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><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/CharArrayClob.html" target="_top">Frames</a></li> +<li><a href="CharArrayClob.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"> +<h2 title="Uses of Class com.amazon.carbonado.lob.CharArrayClob" class="title">Uses of Class<br>com.amazon.carbonado.lob.CharArrayClob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.CharArrayClob</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/CharArrayClob.html" target="_top">Frames</a></li> +<li><a href="CharArrayClob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Clob.html b/apidocs/com/amazon/carbonado/lob/class-use/Clob.html new file mode 100644 index 0000000..04b5b7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Clob.html @@ -0,0 +1,362 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.lob.Clob (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="Uses of Interface com.amazon.carbonado.lob.Clob (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><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Clob.html" target="_top">Frames</a></li> +<li><a href="Clob.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"> +<h2 title="Uses of Interface com.amazon.carbonado.lob.Clob" class="title">Uses of Interface<br>com.amazon.carbonado.lob.Clob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> that return <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<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"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToClob(java.lang.String)">adaptToClob</a></strong>(java.lang.String text)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Clob)">adaptToString</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that implement <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></strong></code> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></strong></code> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<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"><span class="strong">RawSupport.</span><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> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertClob(java.sql.Clob, com.amazon.carbonado.repo.jdbc.JDBCClobLoader)">convertClob</a></strong>(java.sql.Clob clob, + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a> loader)</code> </td> +</tr> +<tr class="rowColor"> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setClobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setClobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateClob(com.amazon.carbonado.lob.Clob, com.amazon.carbonado.lob.Clob)">updateClob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> oldClob, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> newClob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<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"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#createNewClob(int)">createNewClob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Clob whose length is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<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"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#getClobValue(long)">getClobValue</a></strong>(long locator)</code> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(long locator, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Clob.html" target="_top">Frames</a></li> +<li><a href="Clob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html new file mode 100644 index 0000000..a78da2a --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.FileBlob (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="Uses of Class com.amazon.carbonado.lob.FileBlob (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><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/FileBlob.html" target="_top">Frames</a></li> +<li><a href="FileBlob.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"> +<h2 title="Uses of Class com.amazon.carbonado.lob.FileBlob" class="title">Uses of Class<br>com.amazon.carbonado.lob.FileBlob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.FileBlob</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/FileBlob.html" target="_top">Frames</a></li> +<li><a href="FileBlob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Lob.html b/apidocs/com/amazon/carbonado/lob/class-use/Lob.html new file mode 100644 index 0000000..d632b81 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Lob.html @@ -0,0 +1,251 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.lob.Lob (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="Uses of Interface com.amazon.carbonado.lob.Lob (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><a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Lob.html" target="_top">Frames</a></li> +<li><a href="Lob.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"> +<h2 title="Uses of Interface com.amazon.carbonado.lob.Lob" class="title">Uses of Interface<br>com.amazon.carbonado.lob.Lob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></strong></code> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></strong></code> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that implement <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></strong></code> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></strong></code> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></strong></code> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(com.amazon.carbonado.lob.Lob)">deleteLob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#getLocator(com.amazon.carbonado.lob.Lob)">getLocator</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Lob.html" target="_top">Frames</a></li> +<li><a href="Lob.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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html b/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html new file mode 100644 index 0000000..ff9db45 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.StringClob (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="Uses of Class com.amazon.carbonado.lob.StringClob (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><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/StringClob.html" target="_top">Frames</a></li> +<li><a href="StringClob.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"> +<h2 title="Uses of Class com.amazon.carbonado.lob.StringClob" class="title">Uses of Class<br>com.amazon.carbonado.lob.StringClob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.StringClob</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/StringClob.html" target="_top">Frames</a></li> +<li><a href="StringClob.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> diff --git a/apidocs/com/amazon/carbonado/lob/package-frame.html b/apidocs/com/amazon/carbonado/lob/package-frame.html new file mode 100644 index 0000000..5cd4200 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-frame.html @@ -0,0 +1,32 @@ +<!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.lob (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/lob/package-summary.html" target="classFrame">com.amazon.carbonado.lob</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Blob.html" title="interface in com.amazon.carbonado.lob" target="classFrame"><i>Blob</i></a></li> +<li><a href="Clob.html" title="interface in com.amazon.carbonado.lob" target="classFrame"><i>Clob</i></a></li> +<li><a href="Lob.html" title="interface in com.amazon.carbonado.lob" target="classFrame"><i>Lob</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractBlob.html" title="class in com.amazon.carbonado.lob" target="classFrame">AbstractBlob</a></li> +<li><a href="AbstractClob.html" title="class in com.amazon.carbonado.lob" target="classFrame">AbstractClob</a></li> +<li><a href="BlobClob.html" title="class in com.amazon.carbonado.lob" target="classFrame">BlobClob</a></li> +<li><a href="ByteArrayBlob.html" title="class in com.amazon.carbonado.lob" target="classFrame">ByteArrayBlob</a></li> +<li><a href="CharArrayClob.html" title="class in com.amazon.carbonado.lob" target="classFrame">CharArrayClob</a></li> +<li><a href="FileBlob.html" title="class in com.amazon.carbonado.lob" target="classFrame">FileBlob</a></li> +<li><a href="StringClob.html" title="class in com.amazon.carbonado.lob" target="classFrame">StringClob</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/lob/package-summary.html b/apidocs/com/amazon/carbonado/lob/package-summary.html new file mode 100644 index 0000000..93d2196 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-summary.html @@ -0,0 +1,234 @@ +<!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.lob (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.lob (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><a href="../../../../com/amazon/carbonado/layout/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/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.lob</h1> +<div class="docSummary"> +<div class="block">Support for LOB property types, which are Large OBjects.</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/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></td> +<td class="colLast"> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></td> +<td class="colLast"> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></td> +<td class="colLast"> +<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</code></a>.</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/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></td> +<td class="colLast"> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></td> +<td class="colLast"> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></td> +<td class="colLast"> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></td> +<td class="colLast"> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></td> +<td class="colLast"> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></td> +<td class="colLast"> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></td> +<td class="colLast"> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.lob Description">Package com.amazon.carbonado.lob Description</h2> +<div class="block">Support for LOB property types, which are Large OBjects. Properties declared + as <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blob</code></a> or <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clob</code></a> are treated differently than regular + properties. In particular: + + <ul> + <li>Repository typically stores LOB data external from enclosing storable + <li>LOBs are accessed in a manner similar to how files are accessed + <li>LOB data is often read/written in chunks, so consider accessing in a transaction scope + <li>LOBs cannot be annotated with <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><code>PrimaryKey</code></a>, <a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado"><code>Key</code></a>, <a href="../../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><code>Index</code></a>, <a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a>, + <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>Version</code></a>, or <a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a> + <li>LOBs cannot be used in a <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>query filter</code></a> + </ul> + + <p>Also, setting a LOB property does not dirty that property unless the new + LOB is unequal. Updating a LOB property typically involves operating on the + LOB itself. Setting the LOB property again is useful only when completely + replacing the data, which can be a relatively expensive operation. + + <p>Some repositories require that large text data be stored as a LOB. If the + text property is intended to fit entirely in memory, consider defining the + property as a String instead of a LOB. This allows the repository to decide + if it is appropriate to store it as a LOB. If explicit control over charset + encoding is required, add a <a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TextAdapter</code></a> annotation.</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><a href="../../../../com/amazon/carbonado/layout/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/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> diff --git a/apidocs/com/amazon/carbonado/lob/package-tree.html b/apidocs/com/amazon/carbonado/lob/package-tree.html new file mode 100644 index 0000000..8300746 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-tree.html @@ -0,0 +1,151 @@ +<!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.lob Class Hierarchy (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.lob Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/layout/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/qe/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.lob</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">AbstractBlob</span></a> (implements com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>) +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">ByteArrayBlob</span></a></li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">FileBlob</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">AbstractClob</span></a> (implements com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>) +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">BlobClob</span></a></li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">CharArrayClob</span></a></li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">StringClob</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Lob</span></a> +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Blob</span></a></li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Clob</span></a></li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/layout/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/qe/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/lob/package-use.html b/apidocs/com/amazon/carbonado/lob/package-use.html new file mode 100644 index 0000000..20b3ebe --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-use.html @@ -0,0 +1,293 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.lob (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="Uses of Package com.amazon.carbonado.lob (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.lob" class="title">Uses of Package<br>com.amazon.carbonado.lob</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.adapter">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.adapter">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/AbstractBlob.html#com.amazon.carbonado.lob">AbstractBlob</a> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/AbstractClob.html#com.amazon.carbonado.lob">AbstractClob</a> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.lob">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.lob">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Lob.html#com.amazon.carbonado.lob">Lob</a> +<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.raw">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.raw">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.repo.jdbc">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.repo.jdbc">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.spi">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.spi">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Lob.html#com.amazon.carbonado.spi">Lob</a> +<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/package-frame.html b/apidocs/com/amazon/carbonado/package-frame.html new file mode 100644 index 0000000..8056839 --- /dev/null +++ b/apidocs/com/amazon/carbonado/package-frame.html @@ -0,0 +1,86 @@ +<!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> +<h1 class="bar"><a href="../../../com/amazon/carbonado/package-summary.html" target="classFrame">com.amazon.carbonado</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Cursor.html" title="interface in com.amazon.carbonado" target="classFrame"><i>Cursor</i></a></li> +<li><a href="Query.html" title="interface in com.amazon.carbonado" target="classFrame"><i>Query</i></a></li> +<li><a href="Query.Controller.html" title="interface in com.amazon.carbonado" target="classFrame"><i>Query.Controller</i></a></li> +<li><a href="Repository.html" title="interface in com.amazon.carbonado" target="classFrame"><i>Repository</i></a></li> +<li><a href="RepositoryBuilder.html" title="interface in com.amazon.carbonado" target="classFrame"><i>RepositoryBuilder</i></a></li> +<li><a href="Storable.html" title="interface in com.amazon.carbonado" target="classFrame"><i>Storable</i></a></li> +<li><a href="Storage.html" title="interface in com.amazon.carbonado" target="classFrame"><i>Storage</i></a></li> +<li><a href="Transaction.html" title="interface in com.amazon.carbonado" target="classFrame"><i>Transaction</i></a></li> +<li><a href="TriggerFactory.html" title="interface in com.amazon.carbonado" target="classFrame"><i>TriggerFactory</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="Query.Timeout.html" title="class in com.amazon.carbonado" target="classFrame">Query.Timeout</a></li> +<li><a href="Trigger.html" title="class in com.amazon.carbonado" target="classFrame">Trigger</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="IsolationLevel.html" title="enum in com.amazon.carbonado" target="classFrame">IsolationLevel</a></li> +</ul> +<h2 title="Exceptions">Exceptions</h2> +<ul title="Exceptions"> +<li><a href="ConfigurationException.html" title="class in com.amazon.carbonado" target="classFrame">ConfigurationException</a></li> +<li><a href="ConstraintException.html" title="class in com.amazon.carbonado" target="classFrame">ConstraintException</a></li> +<li><a href="CorruptEncodingException.html" title="class in com.amazon.carbonado" target="classFrame">CorruptEncodingException</a></li> +<li><a href="FetchDeadlockException.html" title="class in com.amazon.carbonado" target="classFrame">FetchDeadlockException</a></li> +<li><a href="FetchException.html" title="class in com.amazon.carbonado" target="classFrame">FetchException</a></li> +<li><a href="FetchInterruptedException.html" title="class in com.amazon.carbonado" target="classFrame">FetchInterruptedException</a></li> +<li><a href="FetchMultipleException.html" title="class in com.amazon.carbonado" target="classFrame">FetchMultipleException</a></li> +<li><a href="FetchNoneException.html" title="class in com.amazon.carbonado" target="classFrame">FetchNoneException</a></li> +<li><a href="FetchTimeoutException.html" title="class in com.amazon.carbonado" target="classFrame">FetchTimeoutException</a></li> +<li><a href="MalformedArgumentException.html" title="class in com.amazon.carbonado" target="classFrame">MalformedArgumentException</a></li> +<li><a href="MalformedFilterException.html" title="class in com.amazon.carbonado" target="classFrame">MalformedFilterException</a></li> +<li><a href="MalformedTypeException.html" title="class in com.amazon.carbonado" target="classFrame">MalformedTypeException</a></li> +<li><a href="MismatchException.html" title="class in com.amazon.carbonado" target="classFrame">MismatchException</a></li> +<li><a href="NonDurableCommitException.html" title="class in com.amazon.carbonado" target="classFrame">NonDurableCommitException</a></li> +<li><a href="OptimisticLockException.html" title="class in com.amazon.carbonado" target="classFrame">OptimisticLockException</a></li> +<li><a href="PersistDeadlockException.html" title="class in com.amazon.carbonado" target="classFrame">PersistDeadlockException</a></li> +<li><a href="PersistDeniedException.html" title="class in com.amazon.carbonado" target="classFrame">PersistDeniedException</a></li> +<li><a href="PersistException.html" title="class in com.amazon.carbonado" target="classFrame">PersistException</a></li> +<li><a href="PersistInterruptedException.html" title="class in com.amazon.carbonado" target="classFrame">PersistInterruptedException</a></li> +<li><a href="PersistMultipleException.html" title="class in com.amazon.carbonado" target="classFrame">PersistMultipleException</a></li> +<li><a href="PersistNoneException.html" title="class in com.amazon.carbonado" target="classFrame">PersistNoneException</a></li> +<li><a href="PersistTimeoutException.html" title="class in com.amazon.carbonado" target="classFrame">PersistTimeoutException</a></li> +<li><a href="RepositoryException.html" title="class in com.amazon.carbonado" target="classFrame">RepositoryException</a></li> +<li><a href="SupportException.html" title="class in com.amazon.carbonado" target="classFrame">SupportException</a></li> +<li><a href="Trigger.Abort.html" title="class in com.amazon.carbonado" target="classFrame">Trigger.Abort</a></li> +<li><a href="UniqueConstraintException.html" title="class in com.amazon.carbonado" target="classFrame">UniqueConstraintException</a></li> +<li><a href="UnsupportedTypeException.html" title="class in com.amazon.carbonado" target="classFrame">UnsupportedTypeException</a></li> +</ul> +<h2 title="Annotation Types">Annotation Types</h2> +<ul title="Annotation Types"> +<li><a href="Alias.html" title="annotation in com.amazon.carbonado" target="classFrame">Alias</a></li> +<li><a href="AlternateKeys.html" title="annotation in com.amazon.carbonado" target="classFrame">AlternateKeys</a></li> +<li><a href="Authoritative.html" title="annotation in com.amazon.carbonado" target="classFrame">Authoritative</a></li> +<li><a href="Automatic.html" title="annotation in com.amazon.carbonado" target="classFrame">Automatic</a></li> +<li><a href="Derived.html" title="annotation in com.amazon.carbonado" target="classFrame">Derived</a></li> +<li><a href="Independent.html" title="annotation in com.amazon.carbonado" target="classFrame">Independent</a></li> +<li><a href="Index.html" title="annotation in com.amazon.carbonado" target="classFrame">Index</a></li> +<li><a href="Indexes.html" title="annotation in com.amazon.carbonado" target="classFrame">Indexes</a></li> +<li><a href="Join.html" title="annotation in com.amazon.carbonado" target="classFrame">Join</a></li> +<li><a href="Key.html" title="annotation in com.amazon.carbonado" target="classFrame">Key</a></li> +<li><a href="Name.html" title="annotation in com.amazon.carbonado" target="classFrame">Name</a></li> +<li><a href="Nullable.html" title="annotation in com.amazon.carbonado" target="classFrame">Nullable</a></li> +<li><a href="PartitionKey.html" title="annotation in com.amazon.carbonado" target="classFrame">PartitionKey</a></li> +<li><a href="PrimaryKey.html" title="annotation in com.amazon.carbonado" target="classFrame">PrimaryKey</a></li> +<li><a href="Sequence.html" title="annotation in com.amazon.carbonado" target="classFrame">Sequence</a></li> +<li><a href="Version.html" title="annotation in com.amazon.carbonado" target="classFrame">Version</a></li> +</ul> +</div> +</body> +</html> 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> diff --git a/apidocs/com/amazon/carbonado/package-tree.html b/apidocs/com/amazon/carbonado/package-tree.html new file mode 100644 index 0000000..f69ce0e --- /dev/null +++ b/apidocs/com/amazon/carbonado/package-tree.html @@ -0,0 +1,248 @@ +<!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 Class Hierarchy (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 Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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</li> +<li><a href="../../../com/amazon/carbonado/adapter/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Query.Timeout</span></a> (implements com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>)</li> +<li type="circle">java.lang.Throwable (implements java.io.Serializable) +<ul> +<li type="circle">java.lang.Exception +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado"><span class="strong">RepositoryException</span></a> +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado"><span class="strong">FetchException</span></a> +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado"><span class="strong">CorruptEncodingException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">FetchDeadlockException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">FetchInterruptedException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">FetchMultipleException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado"><span class="strong">FetchNoneException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">FetchTimeoutException</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado"><span class="strong">PersistException</span></a> +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">ConstraintException</span></a> +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">UniqueConstraintException</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado"><span class="strong">NonDurableCommitException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><span class="strong">OptimisticLockException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">PersistDeadlockException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado"><span class="strong">PersistDeniedException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">PersistInterruptedException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">PersistMultipleException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><span class="strong">PersistNoneException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">PersistTimeoutException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado"><span class="strong">Trigger.Abort</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado"><span class="strong">SupportException</span></a> +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado"><span class="strong">ConfigurationException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado"><span class="strong">MismatchException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">UnsupportedTypeException</span></a></li> +</ul> +</li> +</ul> +</li> +<li type="circle">java.lang.RuntimeException +<ul> +<li type="circle">java.lang.IllegalArgumentException +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado"><span class="strong">MalformedArgumentException</span></a> +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado"><span class="strong">MalformedFilterException</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">MalformedTypeException</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Trigger</span></a><S></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">java.lang.AutoCloseable +<ul> +<li type="circle">java.io.Closeable +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Query.Controller</span></a> (also extends java.io.Serializable)</li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado"><span class="strong">Cursor</span></a><S></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Query</span></a><S></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><span class="strong">Repository</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><span class="strong">RepositoryBuilder</span></a></li> +<li type="circle">java.io.Serializable +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Query.Controller</span></a> (also extends java.io.Closeable)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><S></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><span class="strong">Storage</span></a><S></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><span class="strong">Transaction</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado"><span class="strong">TriggerFactory</span></a></li> +</ul> +<h2 title="Annotation Type Hierarchy">Annotation Type Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado"><span class="strong">Automatic</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><span class="strong">Index</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado"><span class="strong">PartitionKey</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><span class="strong">Authoritative</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado"><span class="strong">Key</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><span class="strong">Join</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><span class="strong">Alias</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><span class="strong">PrimaryKey</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><span class="strong">Nullable</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><span class="strong">Version</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Indexes</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><span class="strong">Sequence</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><span class="strong">Independent</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado"><span class="strong">AlternateKeys</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><span class="strong">Derived</span></a> (implements java.lang.annotation.Annotation)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado"><span class="strong">Name</span></a> (implements java.lang.annotation.Annotation)</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.<a href="../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado"><span class="strong">IsolationLevel</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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</li> +<li><a href="../../../com/amazon/carbonado/adapter/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/package-use.html b/apidocs/com/amazon/carbonado/package-use.html new file mode 100644 index 0000000..8eb42e4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/package-use.html @@ -0,0 +1,1352 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package 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="Uses of Package 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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado" class="title">Uses of Package<br>com.amazon.carbonado</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado">com.amazon.carbonado</a></td> +<td class="colLast"> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.layout">com.amazon.carbonado.layout</a></td> +<td class="colLast"> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.map">com.amazon.carbonado.repo.map</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/ConfigurationException.html#com.amazon.carbonado">ConfigurationException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/ConstraintException.html#com.amazon.carbonado">ConstraintException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Cursor.html#com.amazon.carbonado">Cursor</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado">FetchException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchNoneException.html#com.amazon.carbonado">FetchNoneException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchTimeoutException.html#com.amazon.carbonado">FetchTimeoutException</a> +<div class="block">Thrown if a fetch operation fails because lock acquisition timed out.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/IsolationLevel.html#com.amazon.carbonado">IsolationLevel</a> +<div class="block">Describes a transaction isolation level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/MalformedArgumentException.html#com.amazon.carbonado">MalformedArgumentException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado">PersistException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Query.html#com.amazon.carbonado">Query</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Query.Controller.html#com.amazon.carbonado">Query.Controller</a> +<div class="block">Controller instance can be used to abort query operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Query.Timeout.html#com.amazon.carbonado">Query.Timeout</a> +<div class="block">Timeout controller, for aborting long running queries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado">Repository</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado">RepositoryException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado">Storable</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storage.html#com.amazon.carbonado">Storage</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/SupportException.html#com.amazon.carbonado">SupportException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Transaction.html#com.amazon.carbonado">Transaction</a> +<div class="block">Transactions define atomic operations which can be committed or aborted as a + unit.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Trigger.html#com.amazon.carbonado">Trigger</a> +<div class="block">Callback mechanism to allow custom code to run when a storable is + persisted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Trigger.Abort.html#com.amazon.carbonado">Trigger.Abort</a> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/TriggerFactory.html#com.amazon.carbonado">TriggerFactory</a> +<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"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.adapter">FetchException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.adapter">PersistException</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Cursor.html#com.amazon.carbonado.capability">Cursor</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.capability">PersistException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.capability">Repository</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.capability">RepositoryException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.capability">Storable</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Trigger.html#com.amazon.carbonado.capability">Trigger</a> +<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"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Cursor.html#com.amazon.carbonado.cursor">Cursor</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.cursor">FetchException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Query.Controller.html#com.amazon.carbonado.cursor">Query.Controller</a> +<div class="block">Controller instance can be used to abort query operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.cursor">Storable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Storage.html#com.amazon.carbonado.cursor">Storage</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.filter">Storable</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.gen">FetchException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.gen">PersistException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.gen">Repository</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.gen">Storable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/SupportException.html#com.amazon.carbonado.gen">SupportException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Trigger.html#com.amazon.carbonado.gen">Trigger</a> +<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"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.info">Storable</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.layout"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Alias.html#com.amazon.carbonado.layout">Alias</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/AlternateKeys.html#com.amazon.carbonado.layout">AlternateKeys</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.layout">FetchException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchNoneException.html#com.amazon.carbonado.layout">FetchNoneException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Independent.html#com.amazon.carbonado.layout">Independent</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Nullable.html#com.amazon.carbonado.layout">Nullable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.layout">PersistException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/PrimaryKey.html#com.amazon.carbonado.layout">PrimaryKey</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.layout">Repository</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.layout">RepositoryException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.layout">Storable</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/SupportException.html#com.amazon.carbonado.layout">SupportException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Version.html#com.amazon.carbonado.layout">Version</a> +<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> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.lob">FetchException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.lob">PersistException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.lob">Repository</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Cursor.html#com.amazon.carbonado.qe">Cursor</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.qe">FetchException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/IsolationLevel.html#com.amazon.carbonado.qe">IsolationLevel</a> +<div class="block">Describes a transaction isolation level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.qe">PersistException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistNoneException.html#com.amazon.carbonado.qe">PersistNoneException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Query.html#com.amazon.carbonado.qe">Query</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Query.Controller.html#com.amazon.carbonado.qe">Query.Controller</a> +<div class="block">Controller instance can be used to abort query operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.qe">Repository</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.qe">RepositoryException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.qe">Storable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Storage.html#com.amazon.carbonado.qe">Storage</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/SupportException.html#com.amazon.carbonado.qe">SupportException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Transaction.html#com.amazon.carbonado.qe">Transaction</a> +<div class="block">Transactions define atomic operations which can be committed or aborted as a + unit.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/CorruptEncodingException.html#com.amazon.carbonado.raw">CorruptEncodingException</a> +<div class="block">A CorruptEncodingException is caused when decoding an encoded record fails.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Cursor.html#com.amazon.carbonado.raw">Cursor</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.raw">FetchException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchNoneException.html#com.amazon.carbonado.raw">FetchNoneException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.raw">PersistException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.raw">Storable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/SupportException.html#com.amazon.carbonado.raw">SupportException</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Alias.html#com.amazon.carbonado.repo.indexed">Alias</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/ConfigurationException.html#com.amazon.carbonado.repo.indexed">ConfigurationException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.repo.indexed">FetchException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Independent.html#com.amazon.carbonado.repo.indexed">Independent</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Nullable.html#com.amazon.carbonado.repo.indexed">Nullable</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/PrimaryKey.html#com.amazon.carbonado.repo.indexed">PrimaryKey</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.repo.indexed">Repository</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryBuilder.html#com.amazon.carbonado.repo.indexed">RepositoryBuilder</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.repo.indexed">RepositoryException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.repo.indexed">Storable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Storage.html#com.amazon.carbonado.repo.indexed">Storage</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Version.html#com.amazon.carbonado.repo.indexed">Version</a> +<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> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/ConfigurationException.html#com.amazon.carbonado.repo.jdbc">ConfigurationException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.repo.jdbc">FetchException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.repo.jdbc">PersistException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.repo.jdbc">Repository</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryBuilder.html#com.amazon.carbonado.repo.jdbc">RepositoryBuilder</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.repo.jdbc">RepositoryException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.repo.jdbc">Storable</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/SupportException.html#com.amazon.carbonado.repo.jdbc">SupportException</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/ConfigurationException.html#com.amazon.carbonado.repo.logging">ConfigurationException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.repo.logging">Repository</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryBuilder.html#com.amazon.carbonado.repo.logging">RepositoryBuilder</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.repo.logging">RepositoryException</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.map"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.repo.map">Repository</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryBuilder.html#com.amazon.carbonado.repo.map">RepositoryBuilder</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.repo.map">RepositoryException</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/ConfigurationException.html#com.amazon.carbonado.repo.replicated">ConfigurationException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.repo.replicated">Repository</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryBuilder.html#com.amazon.carbonado.repo.replicated">RepositoryBuilder</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.repo.replicated">RepositoryException</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Alias.html#com.amazon.carbonado.repo.sleepycat">Alias</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/ConfigurationException.html#com.amazon.carbonado.repo.sleepycat">ConfigurationException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Independent.html#com.amazon.carbonado.repo.sleepycat">Independent</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Nullable.html#com.amazon.carbonado.repo.sleepycat">Nullable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.repo.sleepycat">PersistException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/PrimaryKey.html#com.amazon.carbonado.repo.sleepycat">PrimaryKey</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.repo.sleepycat">Repository</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryBuilder.html#com.amazon.carbonado.repo.sleepycat">RepositoryBuilder</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.repo.sleepycat">RepositoryException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.repo.sleepycat">Storable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Version.html#com.amazon.carbonado.repo.sleepycat">Version</a> +<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> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.sequence">FetchException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.sequence">PersistException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.sequence">Repository</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.sequence">RepositoryException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Version.html#com.amazon.carbonado.sequence">Version</a> +<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> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Alias.html#com.amazon.carbonado.spi">Alias</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Authoritative.html#com.amazon.carbonado.spi">Authoritative</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/ConfigurationException.html#com.amazon.carbonado.spi">ConfigurationException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.spi">FetchException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Independent.html#com.amazon.carbonado.spi">Independent</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/IsolationLevel.html#com.amazon.carbonado.spi">IsolationLevel</a> +<div class="block">Describes a transaction isolation level.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/MalformedTypeException.html#com.amazon.carbonado.spi">MalformedTypeException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.spi">PersistException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/PrimaryKey.html#com.amazon.carbonado.spi">PrimaryKey</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Repository.html#com.amazon.carbonado.spi">Repository</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryBuilder.html#com.amazon.carbonado.spi">RepositoryBuilder</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.spi">RepositoryException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.spi">Storable</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storage.html#com.amazon.carbonado.spi">Storage</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/SupportException.html#com.amazon.carbonado.spi">SupportException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Transaction.html#com.amazon.carbonado.spi">Transaction</a> +<div class="block">Transactions define atomic operations which can be committed or aborted as a + unit.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Trigger.html#com.amazon.carbonado.spi">Trigger</a> +<div class="block">Callback mechanism to allow custom code to run when a storable is + persisted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/TriggerFactory.html#com.amazon.carbonado.spi">TriggerFactory</a> +<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> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Version.html#com.amazon.carbonado.spi">Version</a> +<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> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/FetchException.html#com.amazon.carbonado.synthetic">FetchException</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.synthetic">Storable</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/SupportException.html#com.amazon.carbonado.synthetic">SupportException</a> +<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> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> used by <a href="../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Cursor.html#com.amazon.carbonado.txn">Cursor</a> +<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="colOne"><a href="../../../com/amazon/carbonado/class-use/IsolationLevel.html#com.amazon.carbonado.txn">IsolationLevel</a> +<div class="block">Describes a transaction isolation level.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/PersistException.html#com.amazon.carbonado.txn">PersistException</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/RepositoryException.html#com.amazon.carbonado.txn">RepositoryException</a> +<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="altColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Storable.html#com.amazon.carbonado.txn">Storable</a> +<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="rowColor"> +<td class="colOne"><a href="../../../com/amazon/carbonado/class-use/Transaction.html#com.amazon.carbonado.txn">Transaction</a> +<div class="block">Transactions define atomic operations which can be committed or aborted as a + unit.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/amazon/carbonado/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/qe/AbstractQuery.html b/apidocs/com/amazon/carbonado/qe/AbstractQuery.html new file mode 100644 index 0000000..a290d49 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/AbstractQuery.html @@ -0,0 +1,767 @@ +<!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>AbstractQuery (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="AbstractQuery (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/AbstractQuery.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/AbstractQuery.html" target="_top">Frames</a></li> +<li><a href="AbstractQuery.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><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.qe</div> +<h2 title="Class AbstractQuery" class="title">Class AbstractQuery<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.qe.AbstractQuery<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/Query.html" title="interface in com.amazon.carbonado">Query</a><S>, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractQuery<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/Query.html" title="interface in com.amazon.carbonado">Query</a><S>, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">AbstractQuery implements a small set of common Query methods. Subclasses + should consider overriding some of these methods, if it provides better + performance.</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.Query"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></h3> +<code><a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>, <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></li> +</ul> +</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#AbstractQuery()">AbstractQuery</a></strong>()</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/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#and(java.lang.String)">and</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#checkSliceArguments(long, java.lang.Long)">checkSliceArguments</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Called by sliced fetch to ensure that arguments are valid.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne()">deleteOne</a></strong>()</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T)">fetchAfter</a></strong>(T start)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></strong>(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne()">loadOne</a></strong>()</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Attempts to load exactly one matching object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#or(java.lang.String)">or</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative()">printNative</a></strong>()</code> +<div class="block">Print the native query to standard out, which is useful for performance + analysis.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative(java.lang.Appendable)">printNative</a></strong>(java.lang.Appendable app)</code> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan()">printPlan</a></strong>()</code> +<div class="block">Prints the query excecution plan to standard out, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan(java.lang.Appendable)">printPlan</a></strong>(java.lang.Appendable app)</code> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis.</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/qe/AbstractQuery.html#toString()">toString</a></strong>()</code> +<div class="block">Implementation calls appendTo.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne()">tryLoadOne</a></strong>()</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Tries to load one record, but returns null if nothing was found.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Query"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></h3> +<code><a href="../../../../com/amazon/carbonado/Query.html#after(T)">after</a>, <a href="../../../../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and</a>, <a href="../../../../com/amazon/carbonado/Query.html#count()">count</a>, <a href="../../../../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/Query.html#deleteAll()">deleteAll</a>, <a href="../../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a>, <a href="../../../../com/amazon/carbonado/Query.html#exists()">exists</a>, <a href="../../../../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists</a>, <a href="../../../../com/amazon/carbonado/Query.html#fetch()">fetch</a>, <a href="../../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a>, <a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/Query.html#getBlankParameterCount()">getBlankParameterCount</a>, <a href="../../../../com/amazon/carbonado/Query.html#getFilter()">getFilter</a>, <a href="../../../../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues</a>, <a href="../../../../com/amazon/carbonado/Query.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/Query.html#not()">not</a>, <a href="../../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or</a>, <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy</a>, <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy</a>, <a href="../../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable, int)">printNative</a>, <a href="../../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable, int)">printPlan</a>, <a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne()">tryDeleteOne</a>, <a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(boolean)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(byte)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(char)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(double)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(float)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(int)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(long)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#with(short)">with</a>, <a href="../../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">withValues</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.Appender"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</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="AbstractQuery()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractQuery</h4> +<pre>protected AbstractQuery()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="and(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> and(java.lang.String filter) + 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/Query.html#and(java.lang.String)">Query</a></code></strong></div> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#and(java.lang.String)">and</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>filter</code> - query filter expression</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="or(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> or(java.lang.String filter) + 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/Query.html#or(java.lang.String)">Query</a></code></strong></div> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#or(java.lang.String)">or</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>filter</code> - query filter expression</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="fetchAfter(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="fetchAfter(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchAfter</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> fetchAfter(T start) + 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/Query.html#fetchAfter(T)">Query</a></code></strong></div> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total + ordering, then cursor may start at an earlier position. + + <p>Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + + <p>Calling <code>fetchAfter(s)</code> is equivalent to calling <code>after(s).fetch()</code>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T)">fetchAfter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>start</code> - storable to attempt to start after; if null, fetch all results</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</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> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>, +<a href="../../../../com/amazon/carbonado/Query.html#after(T)"><code>Query.after(T)</code></a></dd></dl> +</li> +</ul> +<a name="fetchAfter(com.amazon.carbonado.Storable,com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a><a name="fetchAfter(T, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchAfter</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a>> fetchAfter(T start, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor. This is only effective when query has + been given an explicit <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total + ordering, then cursor may start at an earlier position. + + <p>Note: This method can be very expensive to call repeatedly, if the + query needs to perform a sort operation. Ideally, the query ordering + should match the natural ordering of an index or key. + + <p>Calling <code>fetchAfter(s)</code> is equivalent to calling <code>after(s).fetch()</code>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>start</code> - storable to attempt to start after; if null, fetch all results</dd><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</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> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a>, +<a href="../../../../com/amazon/carbonado/Query.html#after(T)"><code>Query.after(T)</code></a></dd></dl> +</li> +</ul> +<a name="loadOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadOne</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> loadOne() + 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/Query.html#loadOne()">Query</a></code></strong></div> +<div class="block">Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#loadOne()">loadOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="loadOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadOne</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> loadOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Attempts to load exactly one matching object. If the number of matching + records is zero or exceeds one, then an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryLoadOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryLoadOne</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> tryLoadOne() + 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/Query.html#tryLoadOne()">Query</a></code></strong></div> +<div class="block">Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne()">tryLoadOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>null or a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryLoadOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryLoadOne</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> tryLoadOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Tries to load one record, but returns null if nothing was found. Throws + exception if record count is more than one.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>null or a single fetched object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></code> - if more than one matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteOne</h4> +<pre>public void deleteOne() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne()">Query</a></code></strong></div> +<div class="block">Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne()">deleteOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteOne</h4> +<pre>public void deleteOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Deletes one matching object. If the number of matching records is zero or + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="printNative()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printNative()">Query</a></code></strong></div> +<div class="block">Print the native query to standard out, which is useful for performance + analysis. Not all repositories have a native query format. An example + native format is SQL.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printNative()">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable)">Query</a></code></strong></div> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>app</code> - append results here</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printPlan()">Query</a></code></strong></div> +<div class="block">Prints the query excecution plan to standard out, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printPlan()">printPlan</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable)">Query</a></code></strong></div> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable)">printPlan</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">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>app</code> - append results here</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Implementation calls appendTo.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#toString()">toString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public abstract int hashCode()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#hashCode()">hashCode</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public abstract boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="checkSliceArguments(long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>checkSliceArguments</h4> +<pre>protected boolean checkSliceArguments(long from, + java.lang.Long to)</pre> +<div class="block">Called by sliced fetch to ensure that arguments are valid.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>false if from is 0 and to is null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if arguments are invalid</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</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/AbstractQuery.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/AbstractQuery.html" target="_top">Frames</a></li> +<li><a href="AbstractQuery.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html new file mode 100644 index 0000000..8da05d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/AbstractQueryExecutor.html @@ -0,0 +1,479 @@ +<!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>AbstractQueryExecutor (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="AbstractQueryExecutor (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/AbstractQueryExecutor.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/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/AbstractQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="AbstractQueryExecutor.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><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.qe</div> +<h2 title="Class AbstractQueryExecutor" class="title">Class AbstractQueryExecutor<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.qe.AbstractQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></pre> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</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"> +<!-- ======== 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/qe/AbstractQueryExecutor.html#AbstractQueryExecutor()">AbstractQueryExecutor</a></strong>()</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Produces a slice via skip and limit cursors.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a></strong>(int indentLevel)</code> +<div class="block">Adds a constant amount to the given indent level.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Appends spaces to the given appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a></strong>(java.lang.Appendable app)</code> +<div class="block">Appends a newline character.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values)</code> +<div class="block">Does nothing and returns false.</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.qe.QueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</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="AbstractQueryExecutor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractQueryExecutor</h4> +<pre>public AbstractQueryExecutor()</pre> +</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/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the storable type that this executor operates on.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">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="fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Produces a slice via skip and limit cursors. Subclasses are encouraged + to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">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="fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Produces a slice via skip and limit cursors. Subclasses are encouraged + to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>controller</code> - optional controller which can abort query operation</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="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">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></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>controller</code> - optional controller which can abort query operation</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="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Does nothing and returns false.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="indent(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>indent</h4> +<pre>protected void indent(java.lang.Appendable app, + int indentLevel) + throws java.io.IOException</pre> +<div class="block">Appends spaces to the given appendable. Useful for implementing + printNative and printPlan.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="newline(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newline</h4> +<pre>protected void newline(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Appends a newline character.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="increaseIndent(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>increaseIndent</h4> +<pre>protected int increaseIndent(int indentLevel)</pre> +<div class="block">Adds a constant amount to the given indent level. Useful for + implementing printNative and printPlan.</div> +</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/AbstractQueryExecutor.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/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/AbstractQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="AbstractQueryExecutor.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/BoundaryType.html b/apidocs/com/amazon/carbonado/qe/BoundaryType.html new file mode 100644 index 0000000..e9fdeb2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/BoundaryType.html @@ -0,0 +1,347 @@ +<!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>BoundaryType (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="BoundaryType (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/BoundaryType.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/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/BoundaryType.html" target="_top">Frames</a></li> +<li><a href="BoundaryType.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.qe</div> +<h2 title="Enum BoundaryType" class="title">Enum BoundaryType</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.BoundaryType</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">BoundaryType</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>></pre> +<div class="block">Describes a value range boundary.</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"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#EXCLUSIVE">EXCLUSIVE</a></strong></code> +<div class="block">Range boundary is exclusive</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#INCLUSIVE">INCLUSIVE</a></strong></code> +<div class="block">Range boundary is inclusive</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#OPEN">OPEN</a></strong></code> +<div class="block">Range boundary is open</div> +</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>static <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/BoundaryType.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="OPEN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OPEN</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> OPEN</pre> +<div class="block">Range boundary is open</div> +</li> +</ul> +<a name="INCLUSIVE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INCLUSIVE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> INCLUSIVE</pre> +<div class="block">Range boundary is inclusive</div> +</li> +</ul> +<a name="EXCLUSIVE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EXCLUSIVE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> EXCLUSIVE</pre> +<div class="block">Range boundary is exclusive</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (BoundaryType c : BoundaryType.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/BoundaryType.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/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/BoundaryType.html" target="_top">Frames</a></li> +<li><a href="BoundaryType.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/qe/CompositeScore.html b/apidocs/com/amazon/carbonado/qe/CompositeScore.html new file mode 100644 index 0000000..55e6ffc --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/CompositeScore.html @@ -0,0 +1,509 @@ +<!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>CompositeScore (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="CompositeScore (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/CompositeScore.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/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/CompositeScore.html" target="_top">Frames</a></li> +<li><a href="CompositeScore.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.qe</div> +<h2 title="Class CompositeScore" class="title">Class CompositeScore<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.qe.CompositeScore<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">CompositeScore<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Evaluates an index for how well it matches a query's desired filtering and + ordering. A composite score is not a single absolute value – instead it + has a relative weight when compared to other scores.</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/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><code>FilteringScore</code></a>, +<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><code>OrderingScore</code></a></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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#canMergeRemainder(com.amazon.carbonado.qe.CompositeScore)">canMergeRemainder</a></strong>(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator(com.amazon.carbonado.qe.QueryHints)">fullComparator</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#getFilteringScore()">getFilteringScore</a></strong>()</code> +<div class="block">Returns the score on how well the evaluated index performs the desired + filtering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#getOrderingScore()">getOrderingScore</a></strong>()</code> +<div class="block">Returns the score on how well the evaluated index performs the desired + ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator()">localForeignComparator</a></strong>()</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator(com.amazon.carbonado.qe.QueryHints)">localForeignComparator</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</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/qe/CompositeScore.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> filter)</code> +<div class="block">Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> ordering)</code> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced.</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, wait, wait, wait</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="evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</pre> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to evaluate</dd><dd><code>filter</code> - optional filter which cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</pre> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexProperties</code> - index properties to evaluate</dd><dd><code>unique</code> - true if index is unique</dd><dd><code>clustered</code> - true if index is clustered</dd><dd><code>filter</code> - optional filter which cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="localForeignComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localForeignComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>> localForeignComparator()</pre> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes. It determines which CompositeScores are better by + examining identity matches, range matches and ordering. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="localForeignComparator(com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localForeignComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>> localForeignComparator(<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes. It determines which CompositeScores are better by + examining identity matches, range matches and ordering. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hints</code> - optional hints</dd></dl> +</li> +</ul> +<a name="fullComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>> fullComparator()</pre> +<div class="block">Returns a comparator which determines which CompositeScores are + better. It compares identity matches, range matches, ordering, open + range matches, property arrangement and index cost estimate. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="fullComparator(com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>> fullComparator(<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<div class="block">Returns a comparator which determines which CompositeScores are + better. It compares identity matches, range matches, ordering, open + range matches, property arrangement and index cost estimate. It does not + matter if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hints</code> - optional hints</dd></dl> +</li> +</ul> +<a name="getFilteringScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilteringScore</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> getFilteringScore()</pre> +<div class="block">Returns the score on how well the evaluated index performs the desired + filtering.</div> +</li> +</ul> +<a name="getOrderingScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrderingScore</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> getOrderingScore()</pre> +<div class="block">Returns the score on how well the evaluated index performs the desired + ordering.</div> +</li> +</ul> +<a name="canMergeRemainder(com.amazon.carbonado.qe.CompositeScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canMergeRemainder</h4> +<pre>public boolean canMergeRemainder(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</pre> +<div class="block">Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.</div> +</li> +</ul> +<a name="mergeRemainderFilter(com.amazon.carbonado.qe.CompositeScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> mergeRemainderFilter(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</pre> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation. Call canMergeRemainder first to verify if the merge + makes any sense.</div> +</li> +</ul> +<a name="mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> mergeRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</pre> +<div class="block">Merges the remainder orderings of this score with the one given. Call + canMergeRemainder first to verify if the merge makes any sense.</div> +</li> +</ul> +<a name="withRemainderFilter(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> withRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> filter)</pre> +<div class="block">Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated. Other matches are not recalculated.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> withRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> ordering)</pre> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced. Handled count is not recalculated.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/CompositeScore.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/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/CompositeScore.html" target="_top">Frames</a></li> +<li><a href="CompositeScore.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> diff --git a/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html new file mode 100644 index 0000000..3805e4b --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutor.html @@ -0,0 +1,557 @@ +<!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>DelegatedQueryExecutor (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="DelegatedQueryExecutor (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/DelegatedQueryExecutor.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/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/DelegatedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutor.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><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.qe</div> +<h2 title="Class DelegatedQueryExecutor" class="title">Class DelegatedQueryExecutor<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.qe.DelegatedQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DelegatedQueryExecutor<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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></pre> +<div class="block">QueryExecutor which delegates by executing a Query on a Storage.</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"> +<!-- ======== 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/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">DelegatedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)">DelegatedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> executor)</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> +<div class="block">Prints the native query to any appendable, if applicable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</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> +</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="DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DelegatedQueryExecutor</h4> +<pre>public DelegatedQueryExecutor(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> executor) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootStorage</code> - root storage to query</dd><dd><code>executor</code> - executor to emulate</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DelegatedQueryExecutor</h4> +<pre>public DelegatedQueryExecutor(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootStorage</code> - root storage to query</dd><dd><code>filter</code> - optional query filter</dd><dd><code>ordering</code> - optional ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if rootStorage is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></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/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the storable type that this executor operates on.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>controller</code> - optional controller which can abort query operation</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="fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to) + 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/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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></dl> +</li> +</ul> +<a name="fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>controller</code> - optional controller which can abort query operation</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="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Counts the query results using the given filter values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">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></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Counts the query results using the given filter values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>controller</code> - optional controller which can abort query operation</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the native query to any appendable, if applicable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/DelegatedQueryExecutor.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/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/DelegatedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutor.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html new file mode 100644 index 0000000..dad3e85 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html @@ -0,0 +1,298 @@ +<!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>DelegatedQueryExecutorFactory (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="DelegatedQueryExecutorFactory (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/DelegatedQueryExecutorFactory.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/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutorFactory.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><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.qe</div> +<h2 title="Class DelegatedQueryExecutorFactory" class="title">Class DelegatedQueryExecutorFactory<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.qe.DelegatedQueryExecutorFactory<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DelegatedQueryExecutorFactory<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></pre> +<div class="block">QueryExecutorFactory which produces executors which delegate via <a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>DelegatedQueryExecutor</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"> +<!-- ======== 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/qe/DelegatedQueryExecutorFactory.html#DelegatedQueryExecutorFactory(com.amazon.carbonado.Storage)">DelegatedQueryExecutorFactory</a></strong>(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> rootStorage)</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#getStorableType()">getStorableType</a></strong>()</code> </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> +</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="DelegatedQueryExecutorFactory(com.amazon.carbonado.Storage)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DelegatedQueryExecutorFactory</h4> +<pre>public DelegatedQueryExecutorFactory(<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> rootStorage)</pre> +</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/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> getStorableType()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">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="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + 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/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">QueryExecutorFactory</a></code></strong></div> +<div class="block">Returns an executor that handles the given query specification.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">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>filter</code> - optional filter</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</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> +</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/DelegatedQueryExecutorFactory.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/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutorFactory.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/EmptyQuery.html b/apidocs/com/amazon/carbonado/qe/EmptyQuery.html new file mode 100644 index 0000000..2a8af3d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/EmptyQuery.html @@ -0,0 +1,1051 @@ +<!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>EmptyQuery (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="EmptyQuery (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/EmptyQuery.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/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/EmptyQuery.html" target="_top">Frames</a></li> +<li><a href="EmptyQuery.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><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.qe</div> +<h2 title="Class EmptyQuery" class="title">Class EmptyQuery<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><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQuery</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.EmptyQuery<S></li> +</ul> +</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/Query.html" title="interface in com.amazon.carbonado">Query</a><S>, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="strong">EmptyQuery<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><S></pre> +<div class="block">Special query implementation that fetches nothing.</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.Query"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></h3> +<code><a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>, <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></li> +</ul> +</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/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, com.amazon.carbonado.qe.OrderingList)">EmptyQuery</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String...)">EmptyQuery</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String... orderings)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String)">EmptyQuery</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String ordering)</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><T extends <a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#after(T)">after</a></strong>(T start)</code> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Append the string representation of this object to the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#count()">count</a></strong>()</code> +<div class="block">Always returns zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteAll()">deleteAll</a></strong>()</code> +<div class="block">Does nothing.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Does nothing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteOne()">deleteOne</a></strong>()</code> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#exists()">exists</a></strong>()</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetch()">fetch</a></strong>()</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#getBlankParameterCount()">getBlankParameterCount</a></strong>()</code> +<div class="block">Always returns zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Always returns a <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><code>ClosedFilter</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#getFilterValues()">getFilterValues</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#not()">not</a></strong>()</code> +<div class="block">Returns a query that fetches everything, possibly in a specified order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> +<div class="block">Returns a copy of this query ordered by specific property values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> +<div class="block">Returns a copy of this query ordered by a specific property value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#printNative(java.lang.Appendable, int)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#printPlan(java.lang.Appendable, int)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne()">tryDeleteOne</a></strong>()</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Always returns false.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Always throws an IllegalStateException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Throws an IllegalStateException unless no values passed in.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQuery"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#checkSliceArguments(long, java.lang.Long)">checkSliceArguments</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T)">fetchAfter</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne()">loadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative()">printNative</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative(java.lang.Appendable)">printNative</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan()">printPlan</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan(java.lang.Appendable)">printPlan</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne()">tryLoadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="EmptyQuery(com.amazon.carbonado.qe.QueryFactory, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EmptyQuery</h4> +<pre>public EmptyQuery(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> ordering)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - required query factory, used by 'or' and 'not' methods</dd><dd><code>ordering</code> - optional order-by properties</dd></dl> +</li> +</ul> +<a name="EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EmptyQuery</h4> +<pre>public EmptyQuery(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String ordering)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - required query factory, used by 'or' and 'not' methods</dd><dd><code>ordering</code> - optional order-by property</dd></dl> +</li> +</ul> +<a name="EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EmptyQuery</h4> +<pre>public EmptyQuery(<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String... orderings)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - required query factory, used by 'or' and 'not' methods</dd><dd><code>orderings</code> - optional order-by properties</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/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getStorableType()">Query</a></code></strong></div> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</li> +</ul> +<a name="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> getFilter()</pre> +<div class="block">Always returns a <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><code>ClosedFilter</code></a>.</div> +</li> +</ul> +<a name="getFilterValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> getFilterValues()</pre> +<div class="block">Always returns null.</div> +</li> +</ul> +<a name="getBlankParameterCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlankParameterCount</h4> +<pre>public int getBlankParameterCount()</pre> +<div class="block">Always returns zero.</div> +</li> +</ul> +<a name="with(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(int value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(long value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(float value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(double value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(boolean value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(char value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(byte)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(byte value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(short)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(short value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> with(java.lang.Object value)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="withValues(java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> withValues(java.lang.Object... values)</pre> +<div class="block">Throws an IllegalStateException unless no values passed in.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - parameter values to fill in; if null or empty, this + Query instance is returned</dd></dl> +</li> +</ul> +<a name="and(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> and(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter)</pre> +<div class="block">Always throws an IllegalStateException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</dd></dl> +</li> +</ul> +<a name="or(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> or(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> filter) + 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/Query.html#or(com.amazon.carbonado.filter.Filter)">Query</a></code></strong></div> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - query filter</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> not() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a query that fetches everything, possibly in a specified order.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="orderBy(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> orderBy(java.lang.String property) + 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/Query.html#orderBy(java.lang.String)">Query</a></code></strong></div> +<div class="block">Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + + <p>Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - name of property to order by</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="orderBy(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> orderBy(java.lang.String... properties) + 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/Query.html#orderBy(java.lang.String...)">Query</a></code></strong></div> +<div class="block">Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + + <p>Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - names of properties to order by</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="after(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="after(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>after</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> after(T start)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#after(T)">Query</a></code></strong></div> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor. This is only + effective when query has been given an explicit <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total ordering, then query may start at an earlier + position. + + <p>Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - storable to attempt to start after; if null, this query is + returned</dd></dl> +</li> +</ul> +<a name="fetch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> fetch()</pre> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>fetch results</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> fetch(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a></dd></dl> +</li> +</ul> +<a name="fetchSlice(long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> fetchSlice(long from, + java.lang.Long to)</pre> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd></dl> +</li> +</ul> +<a name="fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> fetchSlice(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns an <a href="../../../../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</dd></dl> +</li> +</ul> +<a name="deleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteOne</h4> +<pre>public void deleteOne() + throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></pre> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne()">deleteOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne()">deleteOne</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">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/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd></dl> +</li> +</ul> +<a name="deleteOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteOne</h4> +<pre>public void deleteOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></pre> +<div class="block">Always throws <a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">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>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></code> - if no matching record found</dd></dl> +</li> +</ul> +<a name="tryDeleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>public boolean tryDeleteOne()</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd></dl> +</li> +</ul> +<a name="tryDeleteOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>public boolean tryDeleteOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd></dl> +</li> +</ul> +<a name="deleteAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>public void deleteAll()</pre> +<div class="block">Does nothing.</div> +</li> +</ul> +<a name="deleteAll(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>public void deleteAll(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Does nothing.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd></dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count()</pre> +<div class="block">Always returns zero.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>count of matches</dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>count of matches</dd></dl> +</li> +</ul> +<a name="exists()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public boolean exists()</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if any matches</dd></dl> +</li> +</ul> +<a name="exists(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public boolean exists(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if any matches</dd></dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">Appender</a></code></strong></div> +<div class="block">Append the string representation of this object to the given Appendable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel)</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel)</pre> +<div class="block">Always returns false.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#hashCode()">hashCode</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#hashCode()">hashCode</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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/EmptyQuery.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/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/EmptyQuery.html" target="_top">Frames</a></li> +<li><a href="EmptyQuery.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html new file mode 100644 index 0000000..7153d87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FilteredQueryExecutor.html @@ -0,0 +1,404 @@ +<!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>FilteredQueryExecutor (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="FilteredQueryExecutor (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/FilteredQueryExecutor.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/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/FilteredQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FilteredQueryExecutor.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><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.qe</div> +<h2 title="Class FilteredQueryExecutor" class="title">Class FilteredQueryExecutor<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><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.FilteredQueryExecutor<S></li> +</ul> +</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FilteredQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which wraps another and filters results.</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/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><code>FilteredCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/qe/FilteredQueryExecutor.html#FilteredQueryExecutor(com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.filter.Filter)">FilteredQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> executor, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> filter)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the combined filter of the wrapped executor and the extra filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> +<div class="block">Prints native query of the wrapped executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a></code></li> +</ul> +<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> +</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="FilteredQueryExecutor(com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FilteredQueryExecutor</h4> +<pre>public FilteredQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> executor, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> filter)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executor</code> - executor to wrap</dd><dd><code>filter</code> - filter to apply to cursor</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null or filter is open or closed</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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns the combined filter of the wrapped executor and the extra filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints native query of the wrapped executor.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/FilteredQueryExecutor.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/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/FilteredQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FilteredQueryExecutor.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/FilteringScore.html b/apidocs/com/amazon/carbonado/qe/FilteringScore.html new file mode 100644 index 0000000..e646914 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FilteringScore.html @@ -0,0 +1,932 @@ +<!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>FilteringScore (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="FilteringScore (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/FilteringScore.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/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/FilteringScore.html" target="_top">Frames</a></li> +<li><a href="FilteringScore.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.qe</div> +<h2 title="Class FilteringScore" class="title">Class FilteringScore<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.qe.FilteringScore<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">FilteringScore<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Evaluates an index for how well it matches a query's desired filtering. A + filtering score is not a single absolute value – instead it has a + relative weight when compared to other scores. + + <p>An index matches a desired filtering if the arrangement of properties and + its relational operator matches. A matching <a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ"><code>=</code></a> operator is + an identity match. A range match is determined by a matching operator of + <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>></code></a>, <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>>=</code></a>, <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code><</code></a>, or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code><=</code></a>. Filters with a <a href="../../../../com/amazon/carbonado/filter/RelOp.html#NE"><code>!=</code></a> operator are + ignored. Although not all index properties need to be used, the first must + be and no gaps are allowed. + + <p>A FilteringScore measures the number of filter properties that are + matched and the number that are remaining. If there are remainder + properties, then the user of the evaluated index will need to perform an + additional filtering operation to achieve the desired results. + + <p>In general, a FilteringScore is better than another if it has more + matched properties and fewer remainder properties. Matching more identity + properties is given preference over matching range properties. Index + clustering is also considered for score comparison.</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/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><code>OrderingScore</code></a>, +<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><code>CompositeScore</code></a></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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#canMergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">canMergeRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which FilteringScores are + better.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getArrangementScore()">getArrangementScore</a></strong>()</code> +<div class="block">Returns a value which indicates how well the index property order + matches the property filter specification order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringCount()">getCoveringCount</a></strong>()</code> +<div class="block">Returns number of covering property filters which are supported by the + evaluated index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilter()">getCoveringFilter</a></strong>()</code> +<div class="block">Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<? extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilters()">getCoveringFilters</a></strong>()</code> +<div class="block">Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getCoveringRemainderFilter()">getCoveringRemainderFilter</a></strong>()</code> +<div class="block">Returns the composite remainder filter without including the covering + filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeEndFilters()">getExclusiveRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeStartFilters()">getExclusiveRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getHandledCount()">getHandledCount</a></strong>()</code> +<div class="block">Returns the count of all handled property filters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getHandledFilter()">getHandledFilter</a></strong>()</code> +<div class="block">Returns the composite handled filter, or null if no matches at all.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getIdentityCount()">getIdentityCount</a></strong>()</code> +<div class="block">Returns number of consecutive left-aligned index properties which match + property filters with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ"><code>RelOp.EQ</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilter()">getIdentityFilter</a></strong>()</code> +<div class="block">Returns the composite identity filter, or null if no identity property + filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilters()">getIdentityFilters</a></strong>()</code> +<div class="block">Returns the identity property filters supported by the evaluated + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeEndFilters()">getInclusiveRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeStartFilters()">getInclusiveRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getIndexPropertyCount()">getIndexPropertyCount</a></strong>()</code> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Comparable</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getPreferenceScore()">getPreferenceScore</a></strong>()</code> +<div class="block">Returns a value which indicates user index preference, based on the + original ordering of elements in the filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()">getRangeEndFilters</a></strong>()</code> +<div class="block">Returns the range end property filters supported by the evaluated + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()">getRangeStartFilters</a></strong>()</code> +<div class="block">Returns the range start property filters supported by the evaluated + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRemainderCount()">getRemainderCount</a></strong>()</code> +<div class="block">Returns number of property filters not supported by the evaluated index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilter()">getRemainderFilter</a></strong>()</code> +<div class="block">Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<? extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilters()">getRemainderFilters</a></strong>()</code> +<div class="block">Returns the filters not supported by the evaluated index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#hasAnyMatches()">hasAnyMatches</a></strong>()</code> +<div class="block">Returns true if the identity count is greater than zero or if there is a + range match.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#hasRangeEnd()">hasRangeEnd</a></strong>()</code> +<div class="block">Returns true if any property filter with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a> + or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a> matches an index property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#hasRangeMatch()">hasRangeMatch</a></strong>()</code> +<div class="block">Returns true if there is both a range start and range end.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#hasRangeStart()">hasRangeStart</a></strong>()</code> +<div class="block">Returns true if any property filter with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a> + or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a> matches an index property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#isIndexClustered()">isIndexClustered</a></strong>()</code> +<div class="block">Returns true if evaluated index is clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#isIndexUnique()">isIndexUnique</a></strong>()</code> +<div class="block">Returns true if evaluated index is unique.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#isKeyMatch()">isKeyMatch</a></strong>()</code> +<div class="block">Returns true if evaluated index is unique and each of its properties has + an identity match.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">mergeRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#rangeComparator()">rangeComparator</a></strong>()</code> +<div class="block">Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#shouldReverseRange()">shouldReverseRange</a></strong>()</code> +<div class="block">Returns true if there is a range start or end match, but natural order + of matching property is descending.</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/qe/FilteringScore.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> filter)</code> +<div class="block">Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.</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, wait, wait, wait</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="evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</pre> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to evaluate</dd><dd><code>filter</code> - filter which cannot contain any logical 'or' operations.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</pre> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexProperties</code> - index properties to evaluate</dd><dd><code>unique</code> - true if index is unique</dd><dd><code>clustered</code> - true if index is clustered</dd><dd><code>filter</code> - filter which cannot contain any logical 'or' operations.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="rangeComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>rangeComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>> rangeComparator()</pre> +<div class="block">Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches. It does not matter + if the scores were evaluated for different indexes or storable + types. The comparator returns <code><0</code> if first score is better, + <code>0</code> if equal, or <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="fullComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>> fullComparator()</pre> +<div class="block">Returns a comparator which determines which FilteringScores are + better. It compares identity matches, range matches, open range matches + and property arrangement. It does not matter if the scores were + evaluated for different indexes or storable types. The comparator + returns <code><0</code> if first score is better, <code>0</code> if equal, or + <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="isIndexClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexClustered</h4> +<pre>public boolean isIndexClustered()</pre> +<div class="block">Returns true if evaluated index is clustered. Scans of clustered indexes + are generally faster.</div> +</li> +</ul> +<a name="isIndexUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexUnique</h4> +<pre>public boolean isIndexUnique()</pre> +<div class="block">Returns true if evaluated index is unique.</div> +</li> +</ul> +<a name="getIndexPropertyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexPropertyCount</h4> +<pre>public int getIndexPropertyCount()</pre> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</li> +</ul> +<a name="getIdentityCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdentityCount</h4> +<pre>public int getIdentityCount()</pre> +<div class="block">Returns number of consecutive left-aligned index properties which match + property filters with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ"><code>RelOp.EQ</code></a>.</div> +</li> +</ul> +<a name="getIdentityFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdentityFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getIdentityFilters()</pre> +<div class="block">Returns the identity property filters supported by the evaluated + index. The order of the list matches the order in which the properties + appear in the index. The operator of each filter is <a href="../../../../com/amazon/carbonado/filter/RelOp.html#EQ"><code>RelOp.EQ</code></a>.</div> +</li> +</ul> +<a name="getIdentityFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdentityFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getIdentityFilter()</pre> +<div class="block">Returns the composite identity filter, or null if no identity property + filters.</div> +</li> +</ul> +<a name="hasRangeStart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRangeStart</h4> +<pre>public boolean hasRangeStart()</pre> +<div class="block">Returns true if any property filter with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a> + or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a> matches an index property. The index property used + for the range is the first one following the identity count.</div> +</li> +</ul> +<a name="getRangeStartFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRangeStartFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getRangeStartFilters()</pre> +<div class="block">Returns the range start property filters supported by the evaluated + index. The operator of each filter is either <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a> or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a>. The property of each filter is identical, and the properties + are also identical to any range end filters.</div> +</li> +</ul> +<a name="getExclusiveRangeStartFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExclusiveRangeStartFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getExclusiveRangeStartFilters()</pre> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a>. This list is a subset of + those returned by <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()"><code>getRangeStartFilters()</code></a>.</div> +</li> +</ul> +<a name="getInclusiveRangeStartFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInclusiveRangeStartFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getInclusiveRangeStartFilters()</pre> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a>. This list is a subset of + those returned by <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()"><code>getRangeStartFilters()</code></a>.</div> +</li> +</ul> +<a name="hasRangeEnd()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRangeEnd</h4> +<pre>public boolean hasRangeEnd()</pre> +<div class="block">Returns true if any property filter with an operator of <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a> + or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a> matches an index property. The index property used + for the range is the first one following the identity count.</div> +</li> +</ul> +<a name="getRangeEndFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRangeEndFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getRangeEndFilters()</pre> +<div class="block">Returns the range end property filters supported by the evaluated + index. The operator of each filter is either <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a> or <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>. The property of each filter is identical, and the properties + are also identical to any range start filters.</div> +</li> +</ul> +<a name="getExclusiveRangeEndFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExclusiveRangeEndFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getExclusiveRangeEndFilters()</pre> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a>. This list is a subset of + those returned by <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()"><code>getRangeEndFilters()</code></a>.</div> +</li> +</ul> +<a name="getInclusiveRangeEndFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInclusiveRangeEndFilters</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getInclusiveRangeEndFilters()</pre> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../../../../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>. This list is a subset of + those returned by <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()"><code>getRangeEndFilters()</code></a>.</div> +</li> +</ul> +<a name="getHandledCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandledCount</h4> +<pre>public int getHandledCount()</pre> +<div class="block">Returns the count of all handled property filters.</div> +</li> +</ul> +<a name="getHandledFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandledFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getHandledFilter()</pre> +<div class="block">Returns the composite handled filter, or null if no matches at all.</div> +</li> +</ul> +<a name="hasRangeMatch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasRangeMatch</h4> +<pre>public boolean hasRangeMatch()</pre> +<div class="block">Returns true if there is both a range start and range end.</div> +</li> +</ul> +<a name="hasAnyMatches()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasAnyMatches</h4> +<pre>public boolean hasAnyMatches()</pre> +<div class="block">Returns true if the identity count is greater than zero or if there is a + range match.</div> +</li> +</ul> +<a name="getArrangementScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArrangementScore</h4> +<pre>public int getArrangementScore()</pre> +<div class="block">Returns a value which indicates how well the index property order + matches the property filter specification order. A higher value + can indicate that the index is a slightly better match.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>arrangement value, never negative</dd></dl> +</li> +</ul> +<a name="getPreferenceScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreferenceScore</h4> +<pre>public java.lang.Comparable getPreferenceScore()</pre> +<div class="block">Returns a value which indicates user index preference, based on the + original ordering of elements in the filter. A higher value can + indicate that the index is a slightly better match.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>preference value which can be compared to another one</dd></dl> +</li> +</ul> +<a name="getRemainderCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderCount</h4> +<pre>public int getRemainderCount()</pre> +<div class="block">Returns number of property filters not supported by the evaluated index.</div> +</li> +</ul> +<a name="getRemainderFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderFilters</h4> +<pre>public java.util.List<? extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getRemainderFilters()</pre> +<div class="block">Returns the filters not supported by the evaluated index.</div> +</li> +</ul> +<a name="getRemainderFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getRemainderFilter()</pre> +<div class="block">Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.</div> +</li> +</ul> +<a name="getCoveringCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringCount</h4> +<pre>public int getCoveringCount()</pre> +<div class="block">Returns number of covering property filters which are supported by the + evaluated index. This count is no more than the remainder count. If + hasAnyMatches returns false, then the covering count is zero.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getCoveringFilters()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringFilters</h4> +<pre>public java.util.List<? extends <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>>> getCoveringFilters()</pre> +<div class="block">Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getCoveringFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getCoveringFilter()</pre> +<div class="block">Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getCoveringRemainderFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> getCoveringRemainderFilter()</pre> +<div class="block">Returns the composite remainder filter without including the covering + filter. Returns null if no remainder.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isKeyMatch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isKeyMatch</h4> +<pre>public boolean isKeyMatch()</pre> +<div class="block">Returns true if evaluated index is unique and each of its properties has + an identity match. When index and filter are used in a query, expect at + most one result.</div> +</li> +</ul> +<a name="shouldReverseRange()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldReverseRange</h4> +<pre>public boolean shouldReverseRange()</pre> +<div class="block">Returns true if there is a range start or end match, but natural order + of matching property is descending.</div> +</li> +</ul> +<a name="canMergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canMergeRemainderFilter</h4> +<pre>public boolean canMergeRemainderFilter(<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</pre> +<div class="block">Returns true if the given score uses an index exactly the same as this + one. The only allowed differences are in the remainder filter.</div> +</li> +</ul> +<a name="mergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> mergeRemainderFilter(<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</pre> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation. Call canMergeRemainderFilter first to verify if the + merge makes any sense. Returns null if no remainder filter at all.</div> +</li> +</ul> +<a name="withRemainderFilter(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> withRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> filter)</pre> +<div class="block">Returns a new FilteringScore with the remainder replaced and covering + matches recalculated. Other matches are not recalculated.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/FilteringScore.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/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/FilteringScore.html" target="_top">Frames</a></li> +<li><a href="FilteringScore.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> diff --git a/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html new file mode 100644 index 0000000..2299151 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html @@ -0,0 +1,297 @@ +<!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>FullScanQueryExecutor.Support (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="FullScanQueryExecutor.Support (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/FullScanQueryExecutor.Support.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/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.Support.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.qe</div> +<h2 title="Interface FullScanQueryExecutor.Support" class="title">Interface FullScanQueryExecutor.Support<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 Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">FullScanQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</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/qe/FullScanQueryExecutor.Support.html#countAll()">countAll</a></strong>()</code> +<div class="block">Counts all Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll(com.amazon.carbonado.Query.Controller)">countAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts all Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll()">fetchAll</a></strong>()</code> +<div class="block">Perform a full scan of all Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll(com.amazon.carbonado.Query.Controller)">fetchAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform a full scan of all Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#getStorableType()">getStorableType</a></strong>()</code> </td> +</tr> +</table> +</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>> getStorableType()</pre> +</li> +</ul> +<a name="countAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>countAll</h4> +<pre>long countAll() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts all Storables. Implementation may return -1 to indicate that + default count algorithm should be used.</div> +<dl><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="countAll(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>countAll</h4> +<pre>long countAll(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts all Storables. Implementation may return -1 to indicate that + default count algorithm should be used.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</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="fetchAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchAll</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>> fetchAll() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Perform a full scan of all Storables.</div> +<dl><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="fetchAll(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fetchAll</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a>> fetchAll(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Perform a full scan of all Storables.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</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> +</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/FullScanQueryExecutor.Support.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/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.Support.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> diff --git a/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html new file mode 100644 index 0000000..54f2300 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/FullScanQueryExecutor.html @@ -0,0 +1,446 @@ +<!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>FullScanQueryExecutor (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="FullScanQueryExecutor (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/FullScanQueryExecutor.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/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/FullScanQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.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.qe</div> +<h2 title="Class FullScanQueryExecutor" class="title">Class FullScanQueryExecutor<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><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.FullScanQueryExecutor<S></li> +</ul> +</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FullScanQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</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"> +<!-- ======== 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/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</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/qe/FullScanQueryExecutor.html#FullScanQueryExecutor(com.amazon.carbonado.qe.FullScanQueryExecutor.Support)">FullScanQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns an open filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code></li> +</ul> +<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> +</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="FullScanQueryExecutor(com.amazon.carbonado.qe.FullScanQueryExecutor.Support)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FullScanQueryExecutor</h4> +<pre>public FullScanQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> support)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>support</code> - support for full scan</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if support is null</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="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">AbstractQueryExecutor</a></code></strong></div> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">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></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">AbstractQueryExecutor</a></code></strong></div> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>controller</code> - optional controller which can abort query operation</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns an open filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</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="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> getOrdering()</pre> +<div class="block">Returns an empty list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/FullScanQueryExecutor.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/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/FullScanQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html new file mode 100644 index 0000000..300d9a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html @@ -0,0 +1,518 @@ +<!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>IndexedQueryAnalyzer.Result (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="IndexedQueryAnalyzer.Result (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/IndexedQueryAnalyzer.Result.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/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.Result.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.qe</div> +<h2 title="Class IndexedQueryAnalyzer.Result" class="title">Class IndexedQueryAnalyzer.Result</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IndexedQueryAnalyzer.Result</span> +extends java.lang.Object</pre> +</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#canMergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">canMergeRemainder</a></strong>(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Returns true if the given result uses the same index as this, and in + the same way.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getCompositeScore()">getCompositeScore</a></strong>()</code> +<div class="block">Returns the score on how well the selected index performs the + desired filtering and ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns combined handled and remainder filter for this result.</div> +</td> +</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><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignIndex()">getForeignIndex</a></strong>()</code> +<div class="block">Returns the foreign index that was selected, or null if a local + index was selected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignProperty()">getForeignProperty</a></strong>()</code> +<div class="block">Returns the simple or chained property that maps to the selected + foreign index.</div> +</td> +</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/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getLocalIndex()">getLocalIndex</a></strong>()</code> +<div class="block">Returns the local index that was selected, or null if a foreign + index was selected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns combined handled and remainder orderings for this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderFilter()">getRemainderFilter</a></strong>()</code> +<div class="block">Remainder filter which overrides that in composite score.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderOrdering()">getRemainderOrdering</a></strong>()</code> +<div class="block">Remainder orderings which override that in composite score.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#handlesAnything()">handlesAnything</a></strong>()</code> +<div class="block">Returns true if the selected index does anything at all to filter + results or to order them.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#isIndexClustered()">isIndexClustered</a></strong>()</code> +<div class="block">Returns true if local or foreign index is clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">mergeRemainder</a></strong>(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainderFilter(com.amazon.carbonado.filter.Filter)">mergeRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter)</code> +<div class="block">Merges the remainder filter of this result with the given filter, + returning a new result.</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/qe/IndexedQueryAnalyzer.Result.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderFilter)</code> +<div class="block">Returns a new result with the remainder filter replaced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderOrdering)</code> +<div class="block">Returns a new result with the remainder ordering replaced.</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, wait, wait, wait</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="handlesAnything()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>handlesAnything</h4> +<pre>public boolean handlesAnything()</pre> +<div class="block">Returns true if the selected index does anything at all to filter + results or to order them. If not, a filtered and sorted full scan + makes more sense.</div> +</li> +</ul> +<a name="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getFilter()</pre> +<div class="block">Returns combined handled and remainder filter for this result.</div> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getOrdering()</pre> +<div class="block">Returns combined handled and remainder orderings for this result.</div> +</li> +</ul> +<a name="getCompositeScore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCompositeScore</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getCompositeScore()</pre> +<div class="block">Returns the score on how well the selected index performs the + desired filtering and ordering.</div> +</li> +</ul> +<a name="getRemainderFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getRemainderFilter()</pre> +<div class="block">Remainder filter which overrides that in composite score.</div> +</li> +</ul> +<a name="getRemainderOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getRemainderOrdering()</pre> +<div class="block">Remainder orderings which override that in composite score.</div> +</li> +</ul> +<a name="getLocalIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocalIndex</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/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getLocalIndex()</pre> +<div class="block">Returns the local index that was selected, or null if a foreign + index was selected.</div> +</li> +</ul> +<a name="getForeignIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getForeignIndex</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><?> getForeignIndex()</pre> +<div class="block">Returns the foreign index that was selected, or null if a local + index was selected. If a foreign index has been selected, then a + <a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>JoinedQueryExecutor</code></a> is needed.</div> +</li> +</ul> +<a name="getForeignProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getForeignProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getForeignProperty()</pre> +<div class="block">Returns the simple or chained property that maps to the selected + foreign index. Returns null if foreign index was not selected. This + property corresponds to the "targetToSourceProperty" of <a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>JoinedQueryExecutor</code></a>.</div> +</li> +</ul> +<a name="isIndexClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexClustered</h4> +<pre>public boolean isIndexClustered()</pre> +<div class="block">Returns true if local or foreign index is clustered. Scans of + clustered indexes are generally faster.</div> +</li> +</ul> +<a name="canMergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canMergeRemainder</h4> +<pre>public boolean canMergeRemainder(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</pre> +<div class="block">Returns true if the given result uses the same index as this, and in + the same way. The only allowed differences are in the remainder + filter and orderings.</div> +</li> +</ul> +<a name="mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainder</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> mergeRemainder(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</pre> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result. Call canMergeRemainder first to + verify if the merge makes any sense.</div> +</li> +</ul> +<a name="mergeRemainderFilter(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> mergeRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter)</pre> +<div class="block">Merges the remainder filter of this result with the given filter, + returning a new result. If handlesAnything return true, then it + doesn't usually make sense to call this method.</div> +</li> +</ul> +<a name="withRemainderFilter(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> withRemainderFilter(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderFilter)</pre> +<div class="block">Returns a new result with the remainder filter replaced.</div> +</li> +</ul> +<a name="withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> withRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderOrdering)</pre> +<div class="block">Returns a new result with the remainder ordering replaced.</div> +</li> +</ul> +<a name="createExecutor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createExecutor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> createExecutor() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Creates a QueryExecutor based on this result.</div> +<dl><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></dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/IndexedQueryAnalyzer.Result.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/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.Result.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> diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html new file mode 100644 index 0000000..b427293 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryAnalyzer.html @@ -0,0 +1,316 @@ +<!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>IndexedQueryAnalyzer (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="IndexedQueryAnalyzer (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/IndexedQueryAnalyzer.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/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.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.qe</div> +<h2 title="Class IndexedQueryAnalyzer" class="title">Class IndexedQueryAnalyzer<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.qe.IndexedQueryAnalyzer<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">IndexedQueryAnalyzer<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Analyzes a simple query specification and determines which index is best + suited for its execution. Query filters passed to this analyzer cannot + contain any 'or' operations. + + <p>IndexedQueryAnalyzer is sharable and thread-safe. An instance for a + particular Storable type can be cached, avoiding repeated construction + cost. In addition, the analyzer caches learned foreign indexes.</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/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><code>UnionQueryAnalyzer</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>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</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/qe/IndexedQueryAnalyzer.html#IndexedQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">IndexedQueryAnalyzer</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</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/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#getStorableType()">getStorableType</a></strong>()</code> </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> +</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="IndexedQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IndexedQueryAnalyzer</h4> +<pre>public IndexedQueryAnalyzer(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable being queried</dd><dd><code>access</code> - repository access for examing available indexes</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type or indexProvider is null</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/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> getStorableType()</pre> +</li> +</ul> +<a name="analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>analyze</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> analyze(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter which which must be <a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()"><code>bound</code></a> and cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is not supported</dd> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/IndexedQueryAnalyzer.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/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.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> diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html new file mode 100644 index 0000000..e841803 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.Support.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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IndexedQueryExecutor.Support (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="IndexedQueryExecutor.Support (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/IndexedQueryExecutor.Support.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/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.Support.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.qe</div> +<h2 title="Interface IndexedQueryExecutor.Support" class="title">Interface IndexedQueryExecutor.Support<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 Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">IndexedQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</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><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index)</code> +<div class="block">Returns an open query if the given index supports query access.</div> +</td> +</tr> +</table> +</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="indexEntryQuery(com.amazon.carbonado.info.StorableIndex)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>indexEntryQuery</h4> +<pre><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns an open query if the given index supports query access. If + not supported, return null. An index entry query might be used to + perform filtering and sorting of index entries prior to being + resolved into referenced Storables. + + <p>If an index entry query is returned, the fetchSubset method is + never called by IndexedQueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>index entry query or null if not supported</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="fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchFromIndexEntryQuery</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> fetchFromIndexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetch Storables referenced by the given index entry query. This + method is only called if index supports query access.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open</dd><dd><code>indexEntryQuery</code> - query with no blank parameters, derived from + the query returned by indexEntryQuery</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="fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchFromIndexEntryQuery</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> fetchFromIndexEntryQuery(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Fetch Storables referenced by the given index entry query. This + method is only called if index supports query access.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open</dd><dd><code>indexEntryQuery</code> - query with no blank parameters, derived from + the query returned by indexEntryQuery</dd><dd><code>controller</code> - optional controller which can abort query operation</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="fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSubset</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> fetchSubset(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index. The identity values are aligned with the index properties at + property 0. An optional range start or range end aligns with the index + property following the last of the identity values. + + <p>This method is only called if no index entry query was provided + for the given index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - optional list of exactly matching values to apply to index</dd><dd><code>rangeStartBoundary</code> - start boundary type</dd><dd><code>rangeStartValue</code> - value to start at if boundary is not open</dd><dd><code>rangeEndBoundary</code> - end boundary type</dd><dd><code>rangeEndValue</code> - value to end at if boundary is not open</dd><dd><code>reverseRange</code> - indicates that range operates on a property whose + natural order is descending. Only the code that opens the physical + cursor should examine this parameter. If true, then the range start and + end parameter pairs need to be swapped.</dd><dd><code>reverseOrder</code> - when true, iteration should be reversed from its + natural order</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="fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fetchSubset</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> fetchSubset(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index. The identity values are aligned with the index properties at + property 0. An optional range start or range end aligns with the index + property following the last of the identity values. + + <p>This method is only called if no index entry query was provided + for the given index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - optional list of exactly matching values to apply to index</dd><dd><code>rangeStartBoundary</code> - start boundary type</dd><dd><code>rangeStartValue</code> - value to start at if boundary is not open</dd><dd><code>rangeEndBoundary</code> - end boundary type</dd><dd><code>rangeEndValue</code> - value to end at if boundary is not open</dd><dd><code>reverseRange</code> - indicates that range operates on a property whose + natural order is descending. Only the code that opens the physical + cursor should examine this parameter. If true, then the range start and + end parameter pairs need to be swapped.</dd><dd><code>reverseOrder</code> - when true, iteration should be reversed from its + natural order</dd><dd><code>controller</code> - optional controller which can abort query operation</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> +</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/IndexedQueryExecutor.Support.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/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.Support.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> diff --git a/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html new file mode 100644 index 0000000..89c23a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IndexedQueryExecutor.html @@ -0,0 +1,436 @@ +<!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>IndexedQueryExecutor (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="IndexedQueryExecutor (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/IndexedQueryExecutor.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/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.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.qe</div> +<h2 title="Class IndexedQueryExecutor" class="title">Class IndexedQueryExecutor<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><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.IndexedQueryExecutor<S></li> +</ul> +</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IndexedQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which utilizes an index.</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"> +<!-- ======== 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/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</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/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getCoveringFilter()">getCoveringFilter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code></li> +</ul> +<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> +</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="IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IndexedQueryExecutor</h4> +<pre>public IndexedQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to use, which may be a primary key index</dd><dd><code>score</code> - score determines how best to utilize the index</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></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/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the storable type that this executor operates on.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</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="getCoveringFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCoveringFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> getCoveringFilter()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if executor doesn't support or use a covering index</dd></dl> +</li> +</ul> +<a name="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/IndexedQueryExecutor.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/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IndexedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html new file mode 100644 index 0000000..42310dd --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/IterableQueryExecutor.html @@ -0,0 +1,386 @@ +<!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>IterableQueryExecutor (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="IterableQueryExecutor (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/IterableQueryExecutor.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/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IterableQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IterableQueryExecutor.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><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.qe</div> +<h2 title="Class IterableQueryExecutor" class="title">Class IterableQueryExecutor<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><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.IterableQueryExecutor<S></li> +</ul> +</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IterableQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which fully scans an iterable collection.</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/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><code>IteratorCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/qe/IterableQueryExecutor.html#IterableQueryExecutor(java.lang.Class, java.lang.Iterable)">IterableQueryExecutor</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> iterable)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#IterableQueryExecutor(java.lang.Class, java.lang.Iterable, java.util.concurrent.locks.Lock)">IterableQueryExecutor</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> iterable, + java.util.concurrent.locks.Lock lock)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns an open filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code></li> +</ul> +<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> +</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="IterableQueryExecutor(java.lang.Class, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IterableQueryExecutor</h4> +<pre>public IterableQueryExecutor(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> iterable)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable</dd><dd><code>iterable</code> - collection to iterate over, or null for empty cursor</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</dd></dl> +</li> +</ul> +<a name="IterableQueryExecutor(java.lang.Class, java.lang.Iterable, java.util.concurrent.locks.Lock)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IterableQueryExecutor</h4> +<pre>public IterableQueryExecutor(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> iterable, + java.util.concurrent.locks.Lock lock)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable</dd><dd><code>iterable</code> - collection to iterate over, or null for empty cursor</dd><dd><code>lock</code> - optional lock to hold while cursor is open</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns an open filter.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> getOrdering()</pre> +<div class="block">Returns an empty list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/IterableQueryExecutor.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/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/IterableQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IterableQueryExecutor.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html new file mode 100644 index 0000000..e8fd436 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/JoinedQueryExecutor.html @@ -0,0 +1,374 @@ +<!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>JoinedQueryExecutor (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="JoinedQueryExecutor (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/JoinedQueryExecutor.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/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/JoinedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="JoinedQueryExecutor.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.qe</div> +<h2 title="Class JoinedQueryExecutor" class="title">Class JoinedQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T 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><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><T></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.JoinedQueryExecutor<S,T></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - source type</dd><dd><code>T</code> - target type</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">JoinedQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><T></pre> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type. The source executor is called once per + fetch (outer loop), but the target executor is called once per source result + (inner loop).</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>static <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code></li> +</ul> +<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> +</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="build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public static <T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T> build(<a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins. Filtering and ordering may also be supplied, + in order to better distribute work throughout the join.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repoAccess</code> - used to create query executors for outer and inner loops</dd><dd><code>targetToSourceProperty</code> - join property of <i>target</i> type which maps + to instances of <i>source</i> type</dd><dd><code>targetFilter</code> - optional filter for fetching <i>target</i> instances</dd><dd><code>targetOrdering</code> - optional ordering to apply to <i>target</i> executor + & @param hints optional hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null or if join + property is not a Storable type</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - from RepositoryAccess</dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/JoinedQueryExecutor.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/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/JoinedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="JoinedQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html new file mode 100644 index 0000000..ec60bce --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.Support.html @@ -0,0 +1,254 @@ +<!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>KeyQueryExecutor.Support (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="KeyQueryExecutor.Support (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/KeyQueryExecutor.Support.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/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.Support.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.qe</div> +<h2 title="Interface KeyQueryExecutor.Support" class="title">Interface KeyQueryExecutor.Support<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 Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">KeyQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</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><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +</table> +</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="fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchOne</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> fetchOne(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Select at most one Storable referenced by an index. The identity + values fully specify all elements of the index, and the index is + unique.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - of exactly matching values to apply to index</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="fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fetchOne</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> fetchOne(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Select at most one Storable referenced by an index. The identity + values fully specify all elements of the index, and the index is + unique.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</dd><dd><code>index</code> - index to open, which may be a primary key index</dd><dd><code>identityValues</code> - of exactly matching values to apply to index</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> +</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/KeyQueryExecutor.Support.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/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.Support.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> diff --git a/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html new file mode 100644 index 0000000..4a39b5a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/KeyQueryExecutor.html @@ -0,0 +1,421 @@ +<!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>KeyQueryExecutor (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="KeyQueryExecutor (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/KeyQueryExecutor.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/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/KeyQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.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.qe</div> +<h2 title="Class KeyQueryExecutor" class="title">Class KeyQueryExecutor<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><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.KeyQueryExecutor<S></li> +</ul> +</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">KeyQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</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"> +<!-- ======== 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/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</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/qe/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code></li> +</ul> +<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> +</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="KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KeyQueryExecutor</h4> +<pre>public KeyQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to use, which may be a primary key index</dd><dd><code>score</code> - score determines how best to utilize the index</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null or if index is + not unique or if score is not a key match</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/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the storable type that this executor operates on.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> getOrdering()</pre> +<div class="block">Returns an empty list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/KeyQueryExecutor.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/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/KeyQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/OrderingList.html b/apidocs/com/amazon/carbonado/qe/OrderingList.html new file mode 100644 index 0000000..f33cfe9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/OrderingList.html @@ -0,0 +1,559 @@ +<!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>OrderingList (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="OrderingList (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/OrderingList.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/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/OrderingList.html" target="_top">Frames</a></li> +<li><a href="OrderingList.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><a href="#fields_inherited_from_class_java.util.AbstractList">Field</a> | </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.qe</div> +<h2 title="Class OrderingList" class="title">Class OrderingList<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>java.util.AbstractCollection<E></li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.OrderingList<S></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Iterable<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>>, java.util.Collection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>>, java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">OrderingList<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> +implements java.io.Serializable</pre> +<div class="block">Produces unmodifiable lists of <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><code>orderings</code></a>. Instances + are immutable, canonical and cached. Calls to "equals" and "hashCode" are + fast.</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="../../../../serialized-form.html#com.amazon.carbonado.qe.OrderingList">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_java.util.AbstractList"> +<!-- --> +</a> +<h3>Fields inherited from class java.util.AbstractList</h3> +<code>modCount</code></li> +</ul> +</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/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#concat(java.lang.Class, java.lang.String)">concat</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> type, + java.lang.String property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.info.OrderedProperty)">concat</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.qe.OrderingList)">concat</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> other)</code> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#emptyList()">emptyList</a></strong>()</code> +<div class="block">Returns a canonical empty instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object other)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String...)">get</a></strong>(java.lang.Class<S> type, + java.lang.String... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String)">get</a></strong>(java.lang.Class<S> type, + java.lang.String property)</code> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(int)">get</a></strong>(int index)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#reduce()">reduce</a></strong>()</code> +<div class="block">Eliminates redundant ordering properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#replace(int, com.amazon.carbonado.info.OrderedProperty)">replace</a></strong>(int index, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list with the given element replaced.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#reverseDirections()">reverseDirections</a></strong>()</code> +<div class="block">Returns this list with all orderings in reverse.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#size()">size</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingList.html#subList(int, int)">subList</a></strong>(int fromIndex, + int toIndex)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractList"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractList</h3> +<code>add, add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractCollection</h3> +<code>addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString</code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.List"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.List</h3> +<code>addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray</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="emptyList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>emptyList</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> emptyList()</pre> +<div class="block">Returns a canonical empty instance.</div> +</li> +</ul> +<a name="get(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> get(java.lang.Class<S> type, + java.lang.String property)</pre> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if ordering property is not in S</dd></dl> +</li> +</ul> +<a name="get(java.lang.Class, java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> get(java.lang.Class<S> type, + java.lang.String... orderings)</pre> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any ordering property is not in S</dd></dl> +</li> +</ul> +<a name="get(com.amazon.carbonado.info.OrderedProperty...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> get(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</pre> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</li> +</ul> +<a name="get(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> get(java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</pre> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in class <code>java.util.AbstractCollection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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="get(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> get(int index)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>get</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>get</code> in class <code>java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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="concat(java.lang.Class, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>concat</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> concat(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> type, + java.lang.String property)</pre> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</li> +</ul> +<a name="concat(com.amazon.carbonado.info.OrderedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>concat</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> concat(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</pre> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</li> +</ul> +<a name="concat(com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>concat</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> concat(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> other)</pre> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</li> +</ul> +<a name="reduce()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reduce</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> reduce()</pre> +<div class="block">Eliminates redundant ordering properties.</div> +</li> +</ul> +<a name="reverseDirections()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reverseDirections</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> reverseDirections()</pre> +<div class="block">Returns this list with all orderings in reverse.</div> +</li> +</ul> +<a name="replace(int, com.amazon.carbonado.info.OrderedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replace</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> replace(int index, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</pre> +<div class="block">Returns a list with the given element replaced.</div> +</li> +</ul> +<a name="subList(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subList</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> subList(int fromIndex, + int toIndex)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>subList</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>subList</code> in class <code>java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>hashCode</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>hashCode</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object other)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>equals</code> in interface <code>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>equals</code> in interface <code>java.util.List<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.util.AbstractList<<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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/OrderingList.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/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/OrderingList.html" target="_top">Frames</a></li> +<li><a href="OrderingList.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><a href="#fields_inherited_from_class_java.util.AbstractList">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/qe/OrderingScore.html b/apidocs/com/amazon/carbonado/qe/OrderingScore.html new file mode 100644 index 0000000..6b327ce --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/OrderingScore.html @@ -0,0 +1,547 @@ +<!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>OrderingScore (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="OrderingScore (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/OrderingScore.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/qe/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/OrderingScore.html" target="_top">Frames</a></li> +<li><a href="OrderingScore.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.qe</div> +<h2 title="Class OrderingScore" class="title">Class OrderingScore<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.qe.OrderingScore<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">OrderingScore<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Evaluates an index for how well it matches a query's desired ordering. An + ordering score is not a single absolute value – instead it has a relative + weight when compared to other scores. + + <p>An index matches a desired ordering if the arrangement of properties + matches. Not all properties of the index need to be used, however. Also, + gaps in the arrangement are allowed if a property identity filter + matches. A property identity filter is of the form <code>"a = ?"</code>. + + <p>An OrderingScore measures the number of ordering properties that are + matched and the number that are remaining. If there are remainder + properties, then the user of the evaluated index will need to perform a + post-sort operation to achieve the desired results. + + <p>In general, an OrderingScore is better than another if it has more + matched properties and fewer remainder properties. Index clustering, + property count, and natural order is also considered.</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/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><code>FilteringScore</code></a>, +<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><code>CompositeScore</code></a></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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#canMergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">canMergeRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><?>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which OrderingScores are + better.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getFreeOrdering()">getFreeOrdering</a></strong>()</code> +<div class="block">Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getHandledCount()">getHandledCount</a></strong>()</code> +<div class="block">Returns the number of desired orderings the evaluated index + supports.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getHandledOrdering()">getHandledOrdering</a></strong>()</code> +<div class="block">Returns the ordering properties that the evaluated index supports.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getIndexPropertyCount()">getIndexPropertyCount</a></strong>()</code> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getRemainderCount()">getRemainderCount</a></strong>()</code> +<div class="block">Returns the number of desired orderings the evaluated index does not + support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getRemainderOrdering()">getRemainderOrdering</a></strong>()</code> +<div class="block">Returns the ordering properties that the evaluated index does not + support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#getUnusedOrdering()">getUnusedOrdering</a></strong>()</code> +<div class="block">Returns unused ordering properties of the evaluated index because they + were filtered out.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#isIndexClustered()">isIndexClustered</a></strong>()</code> +<div class="block">Returns true if evaluated index is clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#shouldReverseOrder()">shouldReverseOrder</a></strong>()</code> +<div class="block">Returns true if evaluated index must be iterated in reverse to achieve + the desired ordering.</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/qe/OrderingScore.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> ordering)</code> +<div class="block">Returns a new OrderingScore with the remainder replaced.</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, wait, wait, wait</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="evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</pre> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index to evaluate</dd><dd><code>filter</code> - optional filter which cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S> evaluate(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</pre> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexProperties</code> - index properties to evaluate</dd><dd><code>unique</code> - true if index is unique</dd><dd><code>clustered</code> - true if index is clustered</dd><dd><code>filter</code> - optional filter which cannot contain any logical 'or' operations.</dd><dd><code>ordering</code> - optional properties which define desired ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is null or filter is not supported</dd></dl> +</li> +</ul> +<a name="fullComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullComparator</h4> +<pre>public static java.util.Comparator<<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><?>> fullComparator()</pre> +<div class="block">Returns a comparator which determines which OrderingScores are + better. It does not matter if the scores were evaluated for different + indexes or storable types. The comparator returns <code><0</code> if first + score is better, <code>0</code> if equal, or <code>>0</code> if second is better.</div> +</li> +</ul> +<a name="isIndexClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexClustered</h4> +<pre>public boolean isIndexClustered()</pre> +<div class="block">Returns true if evaluated index is clustered. Scans of clustered indexes + are generally faster.</div> +</li> +</ul> +<a name="getIndexPropertyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexPropertyCount</h4> +<pre>public int getIndexPropertyCount()</pre> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</li> +</ul> +<a name="getHandledCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandledCount</h4> +<pre>public int getHandledCount()</pre> +<div class="block">Returns the number of desired orderings the evaluated index + supports. The number of orderings is reduced to eliminate redundancies.</div> +</li> +</ul> +<a name="getHandledOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHandledOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> getHandledOrdering()</pre> +<div class="block">Returns the ordering properties that the evaluated index supports. The + list of orderings is reduced to eliminate redundancies. If any handled + ordering properties originally had an unspecified direction, the correct + direction is specified in this list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>handled orderings, never null</dd></dl> +</li> +</ul> +<a name="getRemainderCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderCount</h4> +<pre>public int getRemainderCount()</pre> +<div class="block">Returns the number of desired orderings the evaluated index does not + support. The number of orderings is reduced to eliminate redundancies. + When the remainder count is non-zero, a query plan which uses the + evaluated index must perform a sort.</div> +</li> +</ul> +<a name="getRemainderOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> getRemainderOrdering()</pre> +<div class="block">Returns the ordering properties that the evaluated index does not + support. The list of orderings is reduced to eliminate redundancies.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>remainder orderings, never null</dd></dl> +</li> +</ul> +<a name="shouldReverseOrder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldReverseOrder</h4> +<pre>public boolean shouldReverseOrder()</pre> +<div class="block">Returns true if evaluated index must be iterated in reverse to achieve + the desired ordering.</div> +</li> +</ul> +<a name="getFreeOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFreeOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> getFreeOrdering()</pre> +<div class="block">Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings. The + direction of any free orderings may be UNSPECIFIED, which indicates that + specific order is not relevant.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>free orderings, never null</dd></dl> +</li> +</ul> +<a name="getUnusedOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUnusedOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> getUnusedOrdering()</pre> +<div class="block">Returns unused ordering properties of the evaluated index because they + were filtered out. The direction of each unused ordering is UNSPECIFIED + because specific order is not relevant.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>unused orderings, never null</dd></dl> +</li> +</ul> +<a name="canMergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canMergeRemainderOrdering</h4> +<pre>public boolean canMergeRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</pre> +<div class="block">Returns true if the given score uses an index exactly the same as this + one. The only allowed differences are in the count of remainder + orderings.</div> +</li> +</ul> +<a name="mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mergeRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> mergeRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</pre> +<div class="block">Merges the remainder orderings of this score with the one given. Call + canMergeRemainderOrdering first to verify if the merge makes any sense.</div> +</li> +</ul> +<a name="withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withRemainderOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> withRemainderOrdering(<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> ordering)</pre> +<div class="block">Returns a new OrderingScore with the remainder replaced. Handled count + is not recalculated.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/OrderingScore.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/qe/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/OrderingScore.html" target="_top">Frames</a></li> +<li><a href="OrderingScore.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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryEngine.html b/apidocs/com/amazon/carbonado/qe/QueryEngine.html new file mode 100644 index 0000000..fdcbeb3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryEngine.html @@ -0,0 +1,329 @@ +<!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>QueryEngine (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="QueryEngine (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/QueryEngine.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/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryEngine.html" target="_top">Frames</a></li> +<li><a href="QueryEngine.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><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.qe</div> +<h2 title="Class QueryEngine" class="title">Class QueryEngine<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><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.StandardQueryFactory</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.QueryEngine<S></li> +</ul> +</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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>, <a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">QueryEngine<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a><S> +implements <a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></pre> +<div class="block">Complete rule-based query engine implementation.</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"> +<!-- ======== 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/qe/QueryEngine.html#QueryEngine(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">QueryEngine</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</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>protected <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.StandardQueryFactory"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#clearExecutors()">clearExecutors</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query()">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(java.lang.String)">query</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#resetExecutors()">resetExecutors</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#setExecutors()">setExecutors</a></code></li> +</ul> +<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.qe.QueryExecutorFactory"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</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="QueryEngine(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QueryEngine</h4> +<pre>public QueryEngine(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">QueryExecutorFactory</a></code></strong></div> +<div class="block">Returns an executor that handles the given query specification.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">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>filter</code> - optional filter</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createQuery</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> createQuery(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQueryFactory</a></code></strong></div> +<div class="block">Implement this method to return query implementations.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">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>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional hints</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/QueryEngine.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/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryEngine.html" target="_top">Frames</a></li> +<li><a href="QueryEngine.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutor.html b/apidocs/com/amazon/carbonado/qe/QueryExecutor.html new file mode 100644 index 0000000..b3f7950 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutor.html @@ -0,0 +1,437 @@ +<!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>QueryExecutor (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="QueryExecutor (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/QueryExecutor.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/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryExecutor.html" target="_top">Frames</a></li> +<li><a href="QueryExecutor.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.qe</div> +<h2 title="Interface QueryExecutor" class="title">Interface QueryExecutor<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 Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a>, <a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">QueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Performs all the actual work of executing a query. QueryExecutors are linked + together forming a <i>query plan</i>.</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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutorFactory</code></a></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/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts the query results using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the storable type that this executor operates on.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Prints the native query to any appendable, if applicable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> getStorableType()</pre> +<div class="block">Returns the storable type that this executor operates on.</div> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</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="fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +<dl><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="fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> fetchSlice(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</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="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts the query results using the given filter values.</div> +<dl><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="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Counts the query results using the given filter values.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> getOrdering()</pre> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints the native query to any appendable, if applicable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/QueryExecutor.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/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryExecutor.html" target="_top">Frames</a></li> +<li><a href="QueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html b/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html new file mode 100644 index 0000000..9d73f5a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutorCache.html @@ -0,0 +1,300 @@ +<!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>QueryExecutorCache (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="QueryExecutorCache (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/QueryExecutorCache.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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryExecutorCache.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorCache.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><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.qe</div> +<h2 title="Class QueryExecutorCache" class="title">Class QueryExecutorCache<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.qe.QueryExecutorCache<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">QueryExecutorCache<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></pre> +<div class="block">QueryExecutors should be cached since expensive analysis is often required to build + them. By default, a minimum of 100 query executors can be cached per Storable type. + The minimum can be changed with the + "com.amazon.carbonado.qe.QueryExecutorCache.minCapacity" system property.</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"> +<!-- ======== 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/qe/QueryExecutorCache.html#QueryExecutorCache(com.amazon.carbonado.qe.QueryExecutorFactory)">QueryExecutorCache</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> factory)</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#getStorableType()">getStorableType</a></strong>()</code> </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> +</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="QueryExecutorCache(com.amazon.carbonado.qe.QueryExecutorFactory)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QueryExecutorCache</h4> +<pre>public QueryExecutorCache(<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> factory)</pre> +</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/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> getStorableType()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">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="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns an executor from the cache.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">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>filter</code> - optional filter</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/QueryExecutorCache.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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryExecutorCache.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorCache.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html new file mode 100644 index 0000000..f8d3b30 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryExecutorFactory.html @@ -0,0 +1,239 @@ +<!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>QueryExecutorFactory (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="QueryExecutorFactory (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/QueryExecutorFactory.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/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorFactory.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.qe</div> +<h2 title="Interface QueryExecutorFactory" class="title">Interface QueryExecutorFactory<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 Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a>, <a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a>, <a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a>, <a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">QueryExecutorFactory<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a> instances from a query specification.</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><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</a></strong>()</code> </td> +</tr> +</table> +</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> getStorableType()</pre> +</li> +</ul> +<a name="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executor</h4> +<pre><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns an executor that handles the given query specification.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/QueryExecutorFactory.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/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorFactory.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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryFactory.html b/apidocs/com/amazon/carbonado/qe/QueryFactory.html new file mode 100644 index 0000000..4cad899 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryFactory.html @@ -0,0 +1,241 @@ +<!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>QueryFactory (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="QueryFactory (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/QueryFactory.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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryFactory.html" target="_top">Frames</a></li> +<li><a href="QueryFactory.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.qe</div> +<h2 title="Interface QueryFactory" class="title">Interface QueryFactory<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 Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">QueryFactory<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> instances from a query specification.</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>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#getStorableType()">getStorableType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</div> +</td> +</tr> +</table> +</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> getStorableType()</pre> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>query</h4> +<pre><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a query that handles the given query specification.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional hints</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> +</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/QueryFactory.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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryFactory.html" target="_top">Frames</a></li> +<li><a href="QueryFactory.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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryHint.html b/apidocs/com/amazon/carbonado/qe/QueryHint.html new file mode 100644 index 0000000..41f32ac --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHint.html @@ -0,0 +1,320 @@ +<!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>QueryHint (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="QueryHint (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/QueryHint.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/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryHint.html" target="_top">Frames</a></li> +<li><a href="QueryHint.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.qe</div> +<h2 title="Enum QueryHint" class="title">Enum QueryHint</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.QueryHint</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">QueryHint</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>></pre> +<div class="block">Defines a hint key.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><code>QueryHints</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHint.html#CONSUME_SLICE">CONSUME_SLICE</a></strong></code> +<div class="block">Intention to consume a slice of matched records</div> +</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>static <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHint.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHint.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="CONSUME_SLICE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CONSUME_SLICE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> CONSUME_SLICE</pre> +<div class="block">Intention to consume a slice of matched records</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (QueryHint c : QueryHint.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/QueryHint.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/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryHint.html" target="_top">Frames</a></li> +<li><a href="QueryHint.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/qe/QueryHints.html b/apidocs/com/amazon/carbonado/qe/QueryHints.html new file mode 100644 index 0000000..6e631c7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/QueryHints.html @@ -0,0 +1,387 @@ +<!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>QueryHints (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="QueryHints (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/QueryHints.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/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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.qe</div> +<h2 title="Class QueryHints" class="title">Class QueryHints</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.QueryHints</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">QueryHints</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">An immutable map of query hints.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><code>QueryHint</code></a>, +<a href="../../../../serialized-form.html#com.amazon.carbonado.qe.QueryHints">Serialized Form</a></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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#contains(com.amazon.carbonado.qe.QueryHint)">contains</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns false if hint is not provided.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#emptyHints()">emptyHints</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#get(com.amazon.carbonado.qe.QueryHint)">get</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns null if hint is not provided.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#isEmpty()">isEmpty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint)">with</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object with the given hint.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)">with</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</code> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/QueryHints.html#without(com.amazon.carbonado.qe.QueryHint)">without</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object without the given hint.</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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="emptyHints()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>emptyHints</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> emptyHints()</pre> +</li> +</ul> +<a name="with(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> with(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns a new QueryHints object with the given hint. The associated + value is the hint object itself.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if hint is null</dd></dl> +</li> +</ul> +<a name="with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> with(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</pre> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if hint or value is null</dd></dl> +</li> +</ul> +<a name="without(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>without</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> without(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</li> +</ul> +<a name="contains(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns false if hint is not provided.</div> +</li> +</ul> +<a name="get(com.amazon.carbonado.qe.QueryHint)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public java.lang.Object get(<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</pre> +<div class="block">Returns null if hint is not provided.</div> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/QueryHints.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/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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> diff --git a/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html b/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html new file mode 100644 index 0000000..761a4ee --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/RepositoryAccess.html @@ -0,0 +1,238 @@ +<!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>RepositoryAccess (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="RepositoryAccess (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/RepositoryAccess.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/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/RepositoryAccess.html" target="_top">Frames</a></li> +<li><a href="RepositoryAccess.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.qe</div> +<h2 title="Interface RepositoryAccess" class="title">Interface RepositoryAccess</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">RepositoryAccess</span></pre> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>, necessary for query + execution.</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><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html#getRootRepository()">getRootRepository</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html#storageAccessFor(java.lang.Class)">storageAccessFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +</td> +</tr> +</table> +</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="getRootRepository()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRootRepository</h4> +<pre><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> getRootRepository()</pre> +</li> +</ul> +<a name="storageAccessFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>storageAccessFor</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S> storageAccessFor(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>specific type of StorageAccess instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if specified type is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if specified type is not suitable</dd> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/RepositoryAccess.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/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/RepositoryAccess.html" target="_top">Frames</a></li> +<li><a href="RepositoryAccess.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> diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html new file mode 100644 index 0000000..628115a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html @@ -0,0 +1,296 @@ +<!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>SortedQueryExecutor.ArraySortSupport (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="SortedQueryExecutor.ArraySortSupport (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/SortedQueryExecutor.ArraySortSupport.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/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.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><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.qe</div> +<h2 title="Class SortedQueryExecutor.ArraySortSupport" class="title">Class SortedQueryExecutor.ArraySortSupport<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.qe.SortedQueryExecutor.ArraySortSupport<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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">SortedQueryExecutor.ArraySortSupport<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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/qe/SortedQueryExecutor.ArraySortSupport.html#SortedQueryExecutor.ArraySortSupport()">SortedQueryExecutor.ArraySortSupport</a></strong>()</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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Returns a new ArraySortBuffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new ArraySortBuffer.</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> +</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="SortedQueryExecutor.ArraySortSupport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SortedQueryExecutor.ArraySortSupport</h4> +<pre>public SortedQueryExecutor.ArraySortSupport()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createSortBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>> createSortBuffer()</pre> +<div class="block">Returns a new ArraySortBuffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">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="createSortBuffer(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a>> createSortBuffer(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Returns a new ArraySortBuffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">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>controller</code> - optional controller which can abort query operation</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/SortedQueryExecutor.ArraySortSupport.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/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html new file mode 100644 index 0000000..c5b2888 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html @@ -0,0 +1,296 @@ +<!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>SortedQueryExecutor.MergeSortSupport (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="SortedQueryExecutor.MergeSortSupport (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/SortedQueryExecutor.MergeSortSupport.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/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.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><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.qe</div> +<h2 title="Class SortedQueryExecutor.MergeSortSupport" class="title">Class SortedQueryExecutor.MergeSortSupport<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.qe.SortedQueryExecutor.MergeSortSupport<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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">SortedQueryExecutor.MergeSortSupport<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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/qe/SortedQueryExecutor.MergeSortSupport.html#SortedQueryExecutor.MergeSortSupport()">SortedQueryExecutor.MergeSortSupport</a></strong>()</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/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Returns a new MergeSortBuffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new MergeSortBuffer.</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> +</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="SortedQueryExecutor.MergeSortSupport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SortedQueryExecutor.MergeSortSupport</h4> +<pre>public SortedQueryExecutor.MergeSortSupport()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createSortBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>> createSortBuffer()</pre> +<div class="block">Returns a new MergeSortBuffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">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="createSortBuffer(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a>> createSortBuffer(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Returns a new MergeSortBuffer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">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>controller</code> - optional controller which can abort query operation</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/SortedQueryExecutor.MergeSortSupport.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/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html new file mode 100644 index 0000000..714d83d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.Support.html @@ -0,0 +1,241 @@ +<!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>SortedQueryExecutor.Support (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="SortedQueryExecutor.Support (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/SortedQueryExecutor.Support.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/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.Support.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.qe</div> +<h2 title="Interface SortedQueryExecutor.Support" class="title">Interface SortedQueryExecutor.Support<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 Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">SortedQueryExecutor.Support<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</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><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a></strong>()</code> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</td> +</tr> +</table> +</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="createSortBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>> createSortBuffer()</pre> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</li> +</ul> +<a name="createSortBuffer(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSortBuffer</h4> +<pre><a href="../../../../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a>> createSortBuffer(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</pre> +<div class="block">Implementation must return an empty buffer for sorting.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controller</code> - optional controller which can abort query operation</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/SortedQueryExecutor.Support.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/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.Support.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> diff --git a/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html new file mode 100644 index 0000000..9f616f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/SortedQueryExecutor.html @@ -0,0 +1,494 @@ +<!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>SortedQueryExecutor (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="SortedQueryExecutor (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/SortedQueryExecutor.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/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/SortedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.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.qe</div> +<h2 title="Class SortedQueryExecutor" class="title">Class SortedQueryExecutor<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><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.SortedQueryExecutor<S></li> +</ul> +</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SortedQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which wraps another and sorts the results.</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/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><code>SortedCursor</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 class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</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/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Prints native query of the wrapped executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a></code></li> +</ul> +<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> +</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="SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SortedQueryExecutor</h4> +<pre>public SortedQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>support</code> - optional support to control sort buffer; if null, array is used</dd><dd><code>executor</code> - executor to wrap</dd><dd><code>handledOrdering</code> - optional handled ordering</dd><dd><code>remainderOrdering</code> - required remainder ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if executor is null or if + remainder ordering is empty</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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</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="count(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">AbstractQueryExecutor</a></code></strong></div> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">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></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">AbstractQueryExecutor</a></code></strong></div> +<div class="block">Counts results by opening a cursor and skipping entries. Subclasses are + encouraged to override with a more efficient implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>controller</code> - optional controller which can abort query operation</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the filter used by this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints native query of the wrapped executor.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/SortedQueryExecutor.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/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/SortedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/StandardQuery.html b/apidocs/com/amazon/carbonado/qe/StandardQuery.html new file mode 100644 index 0000000..51544d0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StandardQuery.html @@ -0,0 +1,1368 @@ +<!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>StandardQuery (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="StandardQuery (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/StandardQuery.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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/StandardQuery.html" target="_top">Frames</a></li> +<li><a href="StandardQuery.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><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.qe</div> +<h2 title="Class StandardQuery" class="title">Class StandardQuery<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><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQuery</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.StandardQuery<S></li> +</ul> +</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/Query.html" title="interface in com.amazon.carbonado">Query</a><S>, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">StandardQuery<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><S> +implements <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Abstract query implementation which uses a <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.Query"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></h3> +<code><a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a>, <a href="../../../../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></code></li> +</ul> +</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</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><T extends <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> <br><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#after(T)">after</a></strong>(T start)</code> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#and(com.amazon.carbonado.filter.Filter)">and</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Append the string representation of this object to the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#clearExecutor()">clearExecutor</a></strong>()</code> +<div class="block">Clears any cached reference to a query executor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#count()">count</a></strong>()</code> +<div class="block">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#count(com.amazon.carbonado.Query.Controller)">count</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a count of all results matched by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#deleteAll()">deleteAll</a></strong>()</code> +<div class="block">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes zero or more matching objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#executor()">executor</a></strong>()</code> +<div class="block">Returns the executor in use by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#executorFactory()">executorFactory</a></strong>()</code> +<div class="block">Return a QueryExecutorFactory which is used to get an executor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#exists()">exists</a></strong>()</code> +<div class="block">Returns true if any results are matched by this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns true if any results are matched by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetch()">fetch</a></strong>()</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches results for this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></strong>(long from, + java.lang.Long to)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></strong>(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getBlankParameterCount()">getBlankParameterCount</a></strong>()</code> +<div class="block">Returns the amount of blank parameters that need to be filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the query's filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getFilterValues()">getFilterValues</a></strong>()</code> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#not()">not</a></strong>()</code> +<div class="block">Returns a new query which produces all the results not supplied in this + query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#or(com.amazon.carbonado.filter.Filter)">or</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter)</code> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#orderBy(java.lang.String...)">orderBy</a></strong>(java.lang.String... properties)</code> +<div class="block">Returns a copy of this query ordered by specific property values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#orderBy(java.lang.String)">orderBy</a></strong>(java.lang.String property)</code> +<div class="block">Returns a copy of this query ordered by a specific property value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#printNative(java.lang.Appendable, int)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#printPlan(java.lang.Appendable, int)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel)</code> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#queryFactory()">queryFactory</a></strong>()</code> +<div class="block">Return a QueryFactory which is used to form new queries from this one.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()">resetExecutor</a></strong>()</code> +<div class="block">Resets any cached reference to a query executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()">setExecutor</a></strong>()</code> +<div class="block">Ensures that a cached query executor reference is available.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne()">tryDeleteOne</a></strong>()</code> +<div class="block">Deletes zero or one matching objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></strong>(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Deletes zero or one matching objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(boolean)">with</a></strong>(boolean value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(byte)">with</a></strong>(byte value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(char)">with</a></strong>(char value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(double)">with</a></strong>(double value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(float)">with</a></strong>(float value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(int)">with</a></strong>(int value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(long)">with</a></strong>(long value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(java.lang.Object)">with</a></strong>(java.lang.Object value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#with(short)">with</a></strong>(short value)</code> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#withValues(java.lang.Object...)">withValues</a></strong>(java.lang.Object... values)</code> +<div class="block">Returns a copy of this Query with the next blank parameters filled in.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQuery"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#and(java.lang.String)">and</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#checkSliceArguments(long, java.lang.Long)">checkSliceArguments</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne()">deleteOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T)">fetchAfter</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne()">loadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#or(java.lang.String)">or</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative()">printNative</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printNative(java.lang.Appendable)">printNative</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan()">printPlan</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#printPlan(java.lang.Appendable)">printPlan</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#toString()">toString</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne()">tryLoadOne</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StandardQuery</h4> +<pre>protected StandardQuery(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional query hints</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/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> getStorableType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getStorableType()">Query</a></code></strong></div> +<div class="block">Returns the specific type of Storable managed by this object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> getFilter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getFilter()">Query</a></code></strong></div> +<div class="block">Returns the query's filter.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#getFilter()">getFilter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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="getFilterValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> getFilterValues()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getFilterValues()">Query</a></code></strong></div> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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="getBlankParameterCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlankParameterCount</h4> +<pre>public int getBlankParameterCount()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#getBlankParameterCount()">Query</a></code></strong></div> +<div class="block">Returns the amount of blank parameters that need to be filled in. If + zero, then this query is ready to be used.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#getBlankParameterCount()">getBlankParameterCount</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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="with(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(int value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(int)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(int)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(long value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(long)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(long)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(float value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(float)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(float)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(double value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(double)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(double)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(boolean value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(boolean)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(boolean)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(char value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(char)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(char)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(byte)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(byte value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(byte)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(byte)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(short)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(short value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(short)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(short)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="with(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>with</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> with(java.lang.Object value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#with(java.lang.Object)">with</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>value</code> - parameter value to fill in</dd></dl> +</li> +</ul> +<a name="withValues(java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>withValues</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> withValues(java.lang.Object... values)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">Query</a></code></strong></div> +<div class="block">Returns a copy of this Query with the next blank parameters filled in.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">withValues</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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> - parameter values to fill in; if null or empty, this + Query instance is returned</dd></dl> +</li> +</ul> +<a name="and(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>and</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> and(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter) + 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/Query.html#and(com.amazon.carbonado.filter.Filter)">Query</a></code></strong></div> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>filter</code> - query filter</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="or(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> or(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter) + 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/Query.html#or(com.amazon.carbonado.filter.Filter)">Query</a></code></strong></div> +<div class="block">Returns a new query which has another <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>filter</code> - query filter</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="not()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>not</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> not() + 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/Query.html#not()">Query</a></code></strong></div> +<div class="block">Returns a new query which produces all the results not supplied in this + query. Any filled in parameters in this query are copied into the new + one.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#not()">not</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="orderBy(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> orderBy(java.lang.String property) + 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/Query.html#orderBy(java.lang.String)">Query</a></code></strong></div> +<div class="block">Returns a copy of this query ordered by a specific property value. The + property name may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + + <p>Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>property</code> - name of property to order by</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="orderBy(java.lang.String...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orderBy</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> orderBy(java.lang.String... properties) + 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/Query.html#orderBy(java.lang.String...)">Query</a></code></strong></div> +<div class="block">Returns a copy of this query ordered by specific property values. The + property names may be prefixed with '+' or '-' to indicate ascending or + descending order. If the prefix is omitted, ascending order is assumed. + + <p>Note: Specification of ordering properties is not cumulative. Calling + this method will first remove any previous ordering properties.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>properties</code> - names of properties to order by</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="after(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="after(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>after</h4> +<pre>public <T extends <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> after(T start) + 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/Query.html#after(T)">Query</a></code></strong></div> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor. This is only + effective when query has been given an explicit <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a>. If not a total ordering, then query may start at an earlier + position. + + <p>Note: The returned query can be very expensive to fetch from + repeatedly, if the query needs to perform a sort operation. Ideally, the + query ordering should match the natural ordering of an index or key.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#after(T)">after</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>start</code> - storable to attempt to start after; if null, this query is + returned</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="fetch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> fetch() + 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/Query.html#fetch()">Query</a></code></strong></div> +<div class="block">Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetch()">fetch</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</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> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a></dd></dl> +</li> +</ul> +<a name="fetch(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> fetch(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/Query.html#fetch(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Fetches results for this query. If any updates or deletes might be + performed on the results, consider enclosing the fetch in a + transaction. This allows the isolation level and "for update" mode to be + adjusted. Some repositories might otherwise deadlock.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</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> - if storage layer throws an exception</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)"><code>Repository.enterTransaction(IsolationLevel)</code></a></dd></dl> +</li> +</ul> +<a name="fetchSlice(long, java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> fetchSlice(long from, + java.lang.Long to) + 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/Query.html#fetchSlice(long, java.lang.Long)">Query</a></code></strong></div> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a> in order for the slice results to be deterministic.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchSlice</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> fetchSlice(long from, + java.lang.Long to, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range. A slice can be used to limit the number of results from a + query. It is strongly recommended that the query be given a total <a href="../../../../com/amazon/carbonado/Query.html#orderBy(java.lang.String)"><code>ordering</code></a> in order for the slice results to be deterministic.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>from</code> - zero-based <code>from</code> record number, inclusive</dd><dd><code>to</code> - optional zero-based <code>to</code> record number, exclusive</dd><dd><code>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>fetch results</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryDeleteOne()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>public boolean tryDeleteOne() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne()">Query</a></code></strong></div> +<div class="block">Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne()">tryDeleteOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="tryDeleteOne(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryDeleteOne</h4> +<pre>public boolean tryDeleteOne(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Deletes zero or one matching objects. If the number of matching records + exceeds one, then no delete occurs, and an exception is thrown instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if record existed and was deleted, or false if no match</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></code> - if more than one record matches</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteAll()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>public void deleteAll() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#deleteAll()">Query</a></code></strong></div> +<div class="block">Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteAll()">deleteAll</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="deleteAll(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAll</h4> +<pre>public void deleteAll(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Deletes zero or more matching objects. There is no guarantee that + deleteAll is an atomic operation. If atomic behavior is desired, wrap + the call in a transaction scope.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>controller</code> - optional controller which can abort query operation</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count() + 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/Query.html#count()">Query</a></code></strong></div> +<div class="block">Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#count()">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>count of matches</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="count(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/Query.html#count(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Returns a count of all results matched by this query. Even though no + results are explicitly fetched, this method may still be expensive to + call. The actual performance will vary by repository and available indexes.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>count of matches</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="exists()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public boolean exists() + 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/Query.html#exists()">Query</a></code></strong></div> +<div class="block">Returns true if any results are matched by this query.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#exists()">exists</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if any matches</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="exists(com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public boolean exists(<a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/Query.html#exists(com.amazon.carbonado.Query.Controller)">Query</a></code></strong></div> +<div class="block">Returns true if any results are matched by this query.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>controller</code> - optional controller which can abort query operation</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if any matches</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable, int)">Query</a></code></strong></div> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis. Not all repositories have a native query + format. An example native format is SQL.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable, int)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable, int)">Query</a></code></strong></div> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis. There is no standard format for query plans, nor + is it a requirement that this method be implemented.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable, int)">printPlan</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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>app</code> - append results here</dd><dd><code>indentLevel</code> - amount to indent text, zero for none</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#hashCode()">hashCode</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#hashCode()">hashCode</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Query.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">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="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">Appender</a></code></strong></div> +<div class="block">Append the string representation of this object to the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> getOrdering()</pre> +</li> +</ul> +<a name="executor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executor</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> executor() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns the executor in use by this query.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="setExecutor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutor</h4> +<pre>protected void setExecutor() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Ensures that a cached query executor reference is available. If not, the + query executor factory is called and the executor is cached.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="resetExecutor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetExecutor</h4> +<pre>protected void resetExecutor() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Resets any cached reference to a query executor. If a reference is + available, it is replaced, but a clear reference is not set.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="clearExecutor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearExecutor</h4> +<pre>protected void clearExecutor()</pre> +<div class="block">Clears any cached reference to a query executor. The next time this + Query is used, it will get an executor from the query executor factory + and cache a reference to it.</div> +</li> +</ul> +<a name="enterTransaction(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTransaction</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTransaction(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - minimum desired isolation level</dd></dl> +</li> +</ul> +<a name="queryFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>queryFactory</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> queryFactory()</pre> +<div class="block">Return a QueryFactory which is used to form new queries from this one.</div> +</li> +</ul> +<a name="executorFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executorFactory</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> executorFactory()</pre> +<div class="block">Return a QueryExecutorFactory which is used to get an executor.</div> +</li> +</ul> +<a name="newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>newInstance</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> newInstance(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</pre> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values. The Filter in the FilterValues is the same as was + passed in the constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - non-null values object</dd><dd><code>ordering</code> - order-by properties, never null</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/StandardQuery.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/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/StandardQuery.html" target="_top">Frames</a></li> +<li><a href="StandardQuery.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html b/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html new file mode 100644 index 0000000..d26bbc1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StandardQueryFactory.html @@ -0,0 +1,535 @@ +<!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>StandardQueryFactory (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="StandardQueryFactory (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/StandardQueryFactory.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/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/StandardQueryFactory.html" target="_top">Frames</a></li> +<li><a href="StandardQueryFactory.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><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.qe</div> +<h2 title="Class StandardQueryFactory" class="title">Class StandardQueryFactory<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.qe.StandardQueryFactory<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/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">StandardQueryFactory<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/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S></pre> +<div class="block">Builds and caches StandardQuery instances.</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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#StandardQueryFactory(java.lang.Class)">StandardQueryFactory</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#StandardQueryFactory(java.lang.Class, boolean)">StandardQueryFactory</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> type, + boolean lazySetExecutor)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#clearExecutors()">clearExecutors</a></strong>()</code> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#clearExecutor()"><code>StandardQuery.clearExecutor()</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#getStorableType()">getStorableType</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query()">query</a></strong>()</code> +<div class="block">Returns a new or cached query that fetches everything.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter)</code> +<div class="block">Returns a new or cached query for the given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(java.lang.String)">query</a></strong>(java.lang.String filter)</code> +<div class="block">Returns a new or cached query for the given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#resetExecutors()">resetExecutors</a></strong>()</code> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()"><code>StandardQuery.resetExecutor()</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#setExecutors()">setExecutors</a></strong>()</code> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()"><code>StandardQuery.setExecutor()</code></a>.</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> +</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="StandardQueryFactory(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StandardQueryFactory</h4> +<pre>protected StandardQueryFactory(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> type)</pre> +</li> +</ul> +<a name="StandardQueryFactory(java.lang.Class, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StandardQueryFactory</h4> +<pre>protected StandardQueryFactory(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> type, + boolean lazySetExecutor)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lazySetExecutor</code> - by default, query executors are built and set + eagerly. Pass true to build and set executor on first query use.</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/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> getStorableType()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">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="query()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query that fetches everything.</div> +<dl><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="query(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(java.lang.String filter) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given filter.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given filter.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given query specification.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given query specification.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if filter is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given query specification.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</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="query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>query</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> query(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new or cached query for the given query specification.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">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>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional hints</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="setExecutors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExecutors</h4> +<pre>public void setExecutors() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()"><code>StandardQuery.setExecutor()</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="resetExecutors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetExecutors</h4> +<pre>public void resetExecutors() + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()"><code>StandardQuery.resetExecutor()</code></a>. + This call can be used to rebuild all cached query plans after the set of + available indexes has changed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="clearExecutors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearExecutors</h4> +<pre>public void clearExecutors()</pre> +<div class="block">For each cached query, calls <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html#clearExecutor()"><code>StandardQuery.clearExecutor()</code></a>. + This call can be used to clear all cached query plans after the set of + available indexes has changed.</div> +</li> +</ul> +<a name="createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createQuery</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> createQuery(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Implement this method to return query implementations.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter object, defaults to open filter if null</dd><dd><code>values</code> - optional values object, defaults to filter initial values</dd><dd><code>ordering</code> - optional order-by properties</dd><dd><code>hints</code> - optional hints</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> +</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/StandardQueryFactory.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/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/StandardQueryFactory.html" target="_top">Frames</a></li> +<li><a href="StandardQueryFactory.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html new file mode 100644 index 0000000..cfec807 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StorableIndexSet.html @@ -0,0 +1,565 @@ +<!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>StorableIndexSet (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="StorableIndexSet (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/StorableIndexSet.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/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/StorableIndexSet.html" target="_top">Frames</a></li> +<li><a href="StorableIndexSet.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><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.qe</div> +<h2 title="Class StorableIndexSet" class="title">Class StorableIndexSet<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>java.util.AbstractCollection<E></li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractSet<E></li> +<li> +<ul class="inheritance"> +<li>java.util.TreeSet<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.StorableIndexSet<S></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>>, java.util.Collection<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>>, java.util.NavigableSet<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>>, java.util.Set<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>>, java.util.SortedSet<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorableIndexSet<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.util.TreeSet<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S>></pre> +<div class="block">Manages a set of <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a> objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a>.</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="../../../../serialized-form.html#com.amazon.carbonado.qe.StorableIndexSet">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/qe/StorableIndexSet.html#StorableIndexSet()">StorableIndexSet</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)">StorableIndexSet</a></strong>(<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> set)</code> +<div class="block">Copy constructor.</div> +</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addAlternateKeys(com.amazon.carbonado.info.StorableInfo)">addAlternateKeys</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds all of the alternate keys of the given storable as indexes by + calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo)">addIndexes</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">addIndexes</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)">addKey</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Adds the key as a unique index, preserving the property arrangement.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)">addPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<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/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findKeyIndex(com.amazon.carbonado.info.StorableKey)">findKeyIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Finds the best index to represent the given key.</div> +</td> +</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/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">findPrimaryKeyIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Finds the best index to represent the primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#markClustered(boolean)">markClustered</a></strong>(boolean clustered)</code> +<div class="block">Marks all indexes as clustered or non-clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#reduce()">reduce</a></strong>()</code> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#reduce(com.amazon.carbonado.info.Direction)">reduce</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Set the default direction for all index properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableInfo)">uniquify</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Augment non-unique indexes with primary key properties, thus making them + unique.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Augment non-unique indexes with key properties, thus making them unique.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.TreeSet"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.TreeSet</h3> +<code>add, addAll, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, subSet, subSet, tailSet, tailSet</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractSet"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractSet</h3> +<code>equals, hashCode, removeAll</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractCollection"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractCollection</h3> +<code>containsAll, retainAll, toArray, toArray, toString</code></li> +</ul> +<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>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Set"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Set</h3> +<code>containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray</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="StorableIndexSet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndexSet</h4> +<pre>public StorableIndexSet()</pre> +</li> +</ul> +<a name="StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorableIndexSet</h4> +<pre>public StorableIndexSet(<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> set)</pre> +<div class="block">Copy constructor.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addIndexes(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addIndexes</h4> +<pre>public void addIndexes(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Adds all the indexes of the given storable.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addIndexes</h4> +<pre>public void addIndexes(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</pre> +<div class="block">Adds all the indexes of the given storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - default ordering direction to apply to each + index property</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null</dd></dl> +</li> +</ul> +<a name="addAlternateKeys(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAlternateKeys</h4> +<pre>public void addAlternateKeys(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Adds all of the alternate keys of the given storable as indexes by + calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="addPrimaryKey(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPrimaryKey</h4> +<pre>public void addPrimaryKey(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>. This method should not be called if the primary key + cannot be altered because persistent data is already stored against + it. Instead, the primary key index should be added as a normal index. + + <p>After adding the primary key via this method and after reducing the + set, call <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)"><code>findPrimaryKeyIndex</code></a> to get the + best index to represent the primary key.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="addKey(com.amazon.carbonado.info.StorableKey)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addKey</h4> +<pre>public void addKey(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</pre> +<div class="block">Adds the key as a unique index, preserving the property arrangement.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if key is null</dd></dl> +</li> +</ul> +<a name="reduce()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reduce</h4> +<pre>public void reduce()</pre> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</li> +</ul> +<a name="reduce(com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reduce</h4> +<pre>public void reduce(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</pre> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - replace unspecified property directions with this</dd></dl> +</li> +</ul> +<a name="setDefaultDirection(com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultDirection</h4> +<pre>public void setDefaultDirection(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</pre> +<div class="block">Set the default direction for all index properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultDirection</code> - replace unspecified property directions with this</dd></dl> +</li> +</ul> +<a name="markClustered(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>markClustered</h4> +<pre>public void markClustered(boolean clustered)</pre> +<div class="block">Marks all indexes as clustered or non-clustered.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>clustered</code> - true to mark clustered; false to mark non-clustered</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#isClustered()"><code>StorableIndex.isClustered()</code></a></dd></dl> +</li> +</ul> +<a name="uniquify(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>uniquify</h4> +<pre>public void uniquify(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Augment non-unique indexes with primary key properties, thus making them + unique.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="uniquify(com.amazon.carbonado.info.StorableKey)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>uniquify</h4> +<pre>public void uniquify(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</pre> +<div class="block">Augment non-unique indexes with key properties, thus making them unique.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if key is null</dd></dl> +</li> +</ul> +<a name="findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findPrimaryKeyIndex</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/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> findPrimaryKeyIndex(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</pre> +<div class="block">Finds the best index to represent the primary key. Should be called + after calling reduce. As long as the primary key was added via <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)"><code>addPrimaryKey</code></a>, this method should never return null.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if info is null</dd></dl> +</li> +</ul> +<a name="findKeyIndex(com.amazon.carbonado.info.StorableKey)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>findKeyIndex</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/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> findKeyIndex(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</pre> +<div class="block">Finds the best index to represent the given key. Should be called after + calling reduce. As long as the key was added via <a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>, + this method should never return null.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if key is null</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/StorableIndexSet.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/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/StorableIndexSet.html" target="_top">Frames</a></li> +<li><a href="StorableIndexSet.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/StorageAccess.html b/apidocs/com/amazon/carbonado/qe/StorageAccess.html new file mode 100644 index 0000000..affde1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/StorageAccess.html @@ -0,0 +1,305 @@ +<!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>StorageAccess (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="StorageAccess (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/StorageAccess.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/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/StorageAccess.html" target="_top">Frames</a></li> +<li><a href="StorageAccess.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.qe</div> +<h2 title="Interface StorageAccess" class="title">Interface StorageAccess<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/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorageAccess<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S></pre> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</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>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#getAllIndexes()">getAllIndexes</a></strong>()</code> +<div class="block">Returns all the available indexes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#getQueryExecutorFactory()">getQueryExecutorFactory</a></strong>()</code> +<div class="block">Returns a QueryExecutorFactory instance for storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html#storageDelegate(com.amazon.carbonado.info.StorableIndex)">storageDelegate</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> index)</code> +<div class="block">If the given index is not directly supported by storage, queries should + be delegated.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.FullScanQueryExecutor.Support"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll()">countAll</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll(com.amazon.carbonado.Query.Controller)">countAll</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll()">fetchAll</a>, <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll(com.amazon.carbonado.Query.Controller)">fetchAll</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.KeyQueryExecutor.Support"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne</a>, <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.IndexedQueryExecutor.Support"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a>, <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.SortedQueryExecutor.Support"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer</a>, <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> getStorableType()</pre> +<div class="block">Returns the specific type of Storable managed by this object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">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="getQueryExecutorFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQueryExecutorFactory</h4> +<pre><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> getQueryExecutorFactory()</pre> +<div class="block">Returns a QueryExecutorFactory instance for storage.</div> +</li> +</ul> +<a name="getAllIndexes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllIndexes</h4> +<pre>java.util.Collection<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>>> getAllIndexes()</pre> +<div class="block">Returns all the available indexes.</div> +</li> +</ul> +<a name="storageDelegate(com.amazon.carbonado.info.StorableIndex)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>storageDelegate</h4> +<pre><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> storageDelegate(<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> index)</pre> +<div class="block">If the given index is not directly supported by storage, queries should + be delegated. Return the storage to delegate to or null if index should + not be delegated.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if index is unknown</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/StorageAccess.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/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/StorageAccess.html" target="_top">Frames</a></li> +<li><a href="StorageAccess.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> diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html new file mode 100644 index 0000000..faf0d05 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html @@ -0,0 +1,271 @@ +<!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>UnionQueryAnalyzer.Result (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="UnionQueryAnalyzer.Result (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/UnionQueryAnalyzer.Result.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/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.Result.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.qe</div> +<h2 title="Class UnionQueryAnalyzer.Result" class="title">Class UnionQueryAnalyzer.Result</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.UnionQueryAnalyzer.Result</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnionQueryAnalyzer.Result</span> +extends java.lang.Object</pre> +</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><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getSubResults()">getSubResults</a></strong>()</code> +<div class="block">Returns results for each sub-query to be executed in the union.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getTotalOrdering()">getTotalOrdering</a></strong>()</code> +<div class="block">Returns a total ordering, if one was imposed.</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> +</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="getSubResults()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubResults</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>> getSubResults()</pre> +<div class="block">Returns results for each sub-query to be executed in the union. If + only one result is returned, then no union needs to be performed.</div> +</li> +</ul> +<a name="getTotalOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTotalOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> getTotalOrdering()</pre> +<div class="block">Returns a total ordering, if one was imposed. Otherwise, null is returned.</div> +</li> +</ul> +<a name="createExecutor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createExecutor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> createExecutor() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Creates a QueryExecutor based on this result.</div> +<dl><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></dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/UnionQueryAnalyzer.Result.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/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.Result.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> diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html new file mode 100644 index 0000000..e797763 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryAnalyzer.html @@ -0,0 +1,350 @@ +<!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>UnionQueryAnalyzer (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="UnionQueryAnalyzer (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/UnionQueryAnalyzer.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/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/UnionQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.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.qe</div> +<h2 title="Class UnionQueryAnalyzer" class="title">Class UnionQueryAnalyzer<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.qe.UnionQueryAnalyzer<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnionQueryAnalyzer<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/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S></pre> +<div class="block">Analyzes a query specification and determines how it can be executed as a + union of smaller queries. If necessary, the UnionQueryAnalyzer will alter + the query slightly, imposing a total ordering. Internally, an <a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryAnalyzer</code></a> is used for selecting the best indexes. + + <p>UnionQueryAnalyzer is sharable and thread-safe. An instance for a + particular Storable type can be cached, avoiding repeated construction + cost. In addition, the analyzer caches learned foreign indexes.</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"> +<!-- ======== 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>class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</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/qe/UnionQueryAnalyzer.html#UnionQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">UnionQueryAnalyzer</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</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/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#getStorableType()">getStorableType</a></strong>()</code> </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> +</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="UnionQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UnionQueryAnalyzer</h4> +<pre>public UnionQueryAnalyzer(java.lang.Class<<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> type, + <a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable being queried</dd><dd><code>access</code> - repository access for examing available indexes</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type or indexProvider is null</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/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> getStorableType()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">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="analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>analyze</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a> analyze(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - optional filter which must be <a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()"><code>bound</code></a></dd><dd><code>ordering</code> - optional properties which define desired ordering</dd><dd><code>hints</code> - optional query hints</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></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>executor</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> executor(<a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns an executor that handles the given query specification.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">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>filter</code> - optional filter which must be <a href="../../../../com/amazon/carbonado/filter/Filter.html#isBound()"><code>bound</code></a></dd><dd><code>ordering</code> - optional properties which define desired ordering</dd><dd><code>hints</code> - optional query hints</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/UnionQueryAnalyzer.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/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/UnionQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.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> diff --git a/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html new file mode 100644 index 0000000..222a230 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/UnionQueryExecutor.html @@ -0,0 +1,434 @@ +<!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>UnionQueryExecutor (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="UnionQueryExecutor (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/UnionQueryExecutor.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/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/UnionQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="UnionQueryExecutor.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><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.qe</div> +<h2 title="Class UnionQueryExecutor" class="title">Class UnionQueryExecutor<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><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">com.amazon.carbonado.qe.AbstractQueryExecutor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.qe.UnionQueryExecutor<S></li> +</ul> +</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/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">UnionQueryExecutor<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S></pre> +<div class="block">QueryExecutor which wraps several others and unions the results.</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/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><code>UnionCursor</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> totalOrdering)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(com.amazon.carbonado.qe.QueryExecutor...)">UnionQueryExecutor</a></strong>(<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>... executors)</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch</a></strong>(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Returns a new cursor using the given filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#getFilter()">getFilter</a></strong>()</code> +<div class="block">Returns the combined filter of the wrapped executors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> +<div class="block">Prints native queries of the wrapped executors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan</a></strong>(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values)</code> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.qe.AbstractQueryExecutor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></h3> +<code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent</a>, <a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline</a></code></li> +</ul> +<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> +</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="UnionQueryExecutor(com.amazon.carbonado.qe.QueryExecutor...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UnionQueryExecutor</h4> +<pre>public UnionQueryExecutor(<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>... executors)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executors</code> - executors to wrap, each must have the exact same total ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null or if ordering doesn't match</dd></dl> +</li> +</ul> +<a name="UnionQueryExecutor(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UnionQueryExecutor</h4> +<pre>public UnionQueryExecutor(java.util.List<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executors</code> - executors to wrap, each must have the exact same total ordering</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any executors is null or if ordering doesn't match</dd></dl> +</li> +</ul> +<a name="UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UnionQueryExecutor</h4> +<pre>public UnionQueryExecutor(java.util.List<<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors, + <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> totalOrdering)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executors</code> - executors to wrap, each must have the exact same total ordering</dd><dd><code>totalOrdering</code> - effective total ordering of executors</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if executors is null</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="fetch(com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><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="fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetch</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> fetch(<a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values, + <a href="../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller) + 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/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">QueryExecutor</a></code></strong></div> +<div class="block">Returns a new cursor using the given filter values.</div> +<dl><dd><code>controller</code> - optional controller which can abort query operation</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="getFilter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> getFilter()</pre> +<div class="block">Returns the combined filter of the wrapped executors.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query filter, never null</dd></dl> +</li> +</ul> +<a name="getOrdering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdering</h4> +<pre>public <a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> getOrdering()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">QueryExecutor</a></code></strong></div> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>query ordering in an unmodifiable list</dd></dl> +</li> +</ul> +<a name="printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printNative</h4> +<pre>public boolean printNative(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block">Prints native queries of the wrapped executors.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in interface <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative</a></code> in class <code><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>printPlan</h4> +<pre>public boolean printPlan(java.lang.Appendable app, + int indentLevel, + <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> values) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">QueryExecutor</a></code></strong></div> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +<dl><dd><code>values</code> - optional</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if not implemented</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/UnionQueryExecutor.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/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/UnionQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="UnionQueryExecutor.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><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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html new file mode 100644 index 0000000..567b706 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQuery.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.AbstractQuery (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="Uses of Class com.amazon.carbonado.qe.AbstractQuery (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><a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/AbstractQuery.html" target="_top">Frames</a></li> +<li><a href="AbstractQuery.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.AbstractQuery" class="title">Uses of Class<br>com.amazon.carbonado.qe.AbstractQuery</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Special query implementation that fetches nothing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Abstract query implementation which uses a <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/AbstractQuery.html" target="_top">Frames</a></li> +<li><a href="AbstractQuery.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html new file mode 100644 index 0000000..ac33f84 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html @@ -0,0 +1,205 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.AbstractQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.AbstractQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="AbstractQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.AbstractQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.AbstractQueryExecutor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and filters results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which utilizes an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and sorts the results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="AbstractQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html b/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html new file mode 100644 index 0000000..e9e0f72 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/BoundaryType.html @@ -0,0 +1,206 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.BoundaryType (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="Uses of Class com.amazon.carbonado.qe.BoundaryType (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><a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/BoundaryType.html" target="_top">Frames</a></li> +<li><a href="BoundaryType.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.BoundaryType" class="title">Uses of Class<br>com.amazon.carbonado.qe.BoundaryType</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></code></td> +<td class="colLast"><span class="strong">BoundaryType.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a>[]</code></td> +<td class="colLast"><span class="strong">BoundaryType.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/BoundaryType.html" target="_top">Frames</a></li> +<li><a href="BoundaryType.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html b/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html new file mode 100644 index 0000000..02be73d --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/CompositeScore.html @@ -0,0 +1,275 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.CompositeScore (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="Uses of Class com.amazon.carbonado.qe.CompositeScore (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><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/CompositeScore.html" target="_top">Frames</a></li> +<li><a href="CompositeScore.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.CompositeScore" class="title">Uses of Class<br>com.amazon.carbonado.qe.CompositeScore</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getCompositeScore()">getCompositeScore</a></strong>()</code> +<div class="block">Returns the score on how well the selected index performs the + desired filtering and ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> filter)</code> +<div class="block">Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> ordering)</code> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator(com.amazon.carbonado.qe.QueryHints)">fullComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator()">localForeignComparator</a></strong>()</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator(com.amazon.carbonado.qe.QueryHints)">localForeignComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#canMergeRemainder(com.amazon.carbonado.qe.CompositeScore)">canMergeRemainder</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/CompositeScore.html" target="_top">Frames</a></li> +<li><a href="CompositeScore.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html new file mode 100644 index 0000000..cc4d958 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.DelegatedQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.DelegatedQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/DelegatedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html new file mode 100644 index 0000000..48f311a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory (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="Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory (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><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutorFactory.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory" class="title">Uses of Class<br>com.amazon.carbonado.qe.DelegatedQueryExecutorFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.DelegatedQueryExecutorFactory</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/DelegatedQueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="DelegatedQueryExecutorFactory.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html new file mode 100644 index 0000000..63377f7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/EmptyQuery.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.EmptyQuery (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="Uses of Class com.amazon.carbonado.qe.EmptyQuery (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><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/EmptyQuery.html" target="_top">Frames</a></li> +<li><a href="EmptyQuery.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.EmptyQuery" class="title">Uses of Class<br>com.amazon.carbonado.qe.EmptyQuery</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.EmptyQuery</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/EmptyQuery.html" target="_top">Frames</a></li> +<li><a href="EmptyQuery.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html new file mode 100644 index 0000000..541d205 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.FilteredQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.FilteredQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FilteredQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.FilteredQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.FilteredQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.FilteredQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FilteredQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FilteredQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html b/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html new file mode 100644 index 0000000..1ef2837 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FilteringScore.html @@ -0,0 +1,246 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.FilteringScore (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="Uses of Class com.amazon.carbonado.qe.FilteringScore (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><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FilteringScore.html" target="_top">Frames</a></li> +<li><a href="FilteringScore.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.FilteringScore" class="title">Uses of Class<br>com.amazon.carbonado.qe.FilteringScore</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#getFilteringScore()">getFilteringScore</a></strong>()</code> +<div class="block">Returns the score on how well the evaluated index performs the desired + filtering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> filter)</code> +<div class="block">Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which FilteringScores are + better.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><?>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#rangeComparator()">rangeComparator</a></strong>()</code> +<div class="block">Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#canMergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">canMergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">mergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a>> other)</code> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FilteringScore.html" target="_top">Frames</a></li> +<li><a href="FilteringScore.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html new file mode 100644 index 0000000..68b5038 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html @@ -0,0 +1,173 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support (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="Uses of Interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support (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><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.Support.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support" class="title">Uses of Interface<br>com.amazon.carbonado.qe.FullScanQueryExecutor.Support</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#FullScanQueryExecutor(com.amazon.carbonado.qe.FullScanQueryExecutor.Support)">FullScanQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>> support)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.Support.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html new file mode 100644 index 0000000..b7289bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.FullScanQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.FullScanQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.FullScanQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.FullScanQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.FullScanQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="FullScanQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html new file mode 100644 index 0000000..ec724a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html @@ -0,0 +1,225 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result (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="Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result (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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.Result.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result" class="title">Uses of Class<br>com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">mergeRemainder</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainderFilter(com.amazon.carbonado.filter.Filter)">mergeRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter)</code> +<div class="block">Merges the remainder filter of this result with the given filter, + returning a new result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderFilter)</code> +<div class="block">Returns a new result with the remainder filter replaced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderOrdering)</code> +<div class="block">Returns a new result with the remainder ordering replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getSubResults()">getSubResults</a></strong>()</code> +<div class="block">Returns results for each sub-query to be executed in the union.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#canMergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">canMergeRemainder</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Returns true if the given result uses the same index as this, and in + the same way.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">mergeRemainder</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> other)</code> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.Result.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html new file mode 100644 index 0000000..569b053 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer (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="Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer (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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.IndexedQueryAnalyzer" class="title">Uses of Class<br>com.amazon.carbonado.qe.IndexedQueryAnalyzer</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.IndexedQueryAnalyzer</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryAnalyzer.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html new file mode 100644 index 0000000..da34597 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html @@ -0,0 +1,175 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support (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="Uses of Interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support (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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.Support.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support" class="title">Uses of Interface<br>com.amazon.carbonado.qe.IndexedQueryExecutor.Support</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.Support.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html new file mode 100644 index 0000000..67102f0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.IndexedQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.IndexedQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.IndexedQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.IndexedQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.IndexedQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IndexedQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html new file mode 100644 index 0000000..be08715 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.IterableQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.IterableQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IterableQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.IterableQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.IterableQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.IterableQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/IterableQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="IterableQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html new file mode 100644 index 0000000..d013501 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.JoinedQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.JoinedQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="JoinedQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.JoinedQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.JoinedQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.JoinedQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/JoinedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="JoinedQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html new file mode 100644 index 0000000..4007aa1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html @@ -0,0 +1,175 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.KeyQueryExecutor.Support (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="Uses of Interface com.amazon.carbonado.qe.KeyQueryExecutor.Support (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><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.Support.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.KeyQueryExecutor.Support" class="title">Uses of Interface<br>com.amazon.carbonado.qe.KeyQueryExecutor.Support</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.Support.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html new file mode 100644 index 0000000..4775511 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.KeyQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.KeyQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.KeyQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.KeyQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.KeyQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/KeyQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="KeyQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html b/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html new file mode 100644 index 0000000..87365a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/OrderingList.html @@ -0,0 +1,577 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.OrderingList (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="Uses of Class com.amazon.carbonado.qe.OrderingList (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><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/OrderingList.html" target="_top">Frames</a></li> +<li><a href="OrderingList.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.OrderingList" class="title">Uses of Class<br>com.amazon.carbonado.qe.OrderingList</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(java.lang.Class, java.lang.String)">concat</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> type, + java.lang.String property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.info.OrderedProperty)">concat</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.qe.OrderingList)">concat</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> other)</code> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#emptyList()">emptyList</a></strong>()</code> +<div class="block">Returns a canonical empty instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String...)">get</a></strong>(java.lang.Class<S> type, + java.lang.String... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String)">get</a></strong>(java.lang.Class<S> type, + java.lang.String property)</code> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#getFreeOrdering()">getFreeOrdering</a></strong>()</code> +<div class="block">Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#getHandledOrdering()">getHandledOrdering</a></strong>()</code> +<div class="block">Returns the ordering properties that the evaluated index supports.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a>></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">SortedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IterableQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FullScanQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns an empty list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getOrdering()">getOrdering</a></strong>()</code> +<div class="block">Returns combined handled and remainder orderings for this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">FilteredQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#getOrdering()">getOrdering</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#getRemainderOrdering()">getRemainderOrdering</a></strong>()</code> +<div class="block">Returns the ordering properties that the evaluated index does not + support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderOrdering()">getRemainderOrdering</a></strong>()</code> +<div class="block">Remainder orderings which override that in composite score.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getTotalOrdering()">getTotalOrdering</a></strong>()</code> +<div class="block">Returns a total ordering, if one was imposed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#getUnusedOrdering()">getUnusedOrdering</a></strong>()</code> +<div class="block">Returns unused ordering properties of the evaluated index because they + were filtered out.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#reduce()">reduce</a></strong>()</code> +<div class="block">Eliminates redundant ordering properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#replace(int, com.amazon.carbonado.info.OrderedProperty)">replace</a></strong>(int index, + <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list with the given element replaced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#reverseDirections()">reverseDirections</a></strong>()</code> +<div class="block">Returns this list with all orderings in reverse.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#subList(int, int)">subList</a></strong>(int fromIndex, + int toIndex)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.qe.OrderingList)">concat</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> other)</code> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorCache.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>> ordering)</code> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> ordering)</code> +<div class="block">Returns a new OrderingScore with the remainder replaced.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> remainderOrdering)</code> +<div class="block">Returns a new result with the remainder ordering replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">DelegatedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, com.amazon.carbonado.qe.OrderingList)">EmptyQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> ordering)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> totalOrdering)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/OrderingList.html" target="_top">Frames</a></li> +<li><a href="OrderingList.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html b/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html new file mode 100644 index 0000000..6d59339 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/OrderingScore.html @@ -0,0 +1,226 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.OrderingScore (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="Uses of Class com.amazon.carbonado.qe.OrderingScore (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><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/OrderingScore.html" target="_top">Frames</a></li> +<li><a href="OrderingScore.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.OrderingScore" class="title">Uses of Class<br>com.amazon.carbonado.qe.OrderingScore</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#getOrderingScore()">getOrderingScore</a></strong>()</code> +<div class="block">Returns the score on how well the evaluated index performs the desired + ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> ordering)</code> +<div class="block">Returns a new OrderingScore with the remainder replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><?>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#fullComparator()">fullComparator</a></strong>()</code> +<div class="block">Returns a comparator which determines which OrderingScores are + better.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#canMergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">canMergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">mergeRemainderOrdering</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a>> other)</code> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/OrderingScore.html" target="_top">Frames</a></li> +<li><a href="OrderingScore.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html new file mode 100644 index 0000000..0d3242b --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryEngine.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.QueryEngine (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="Uses of Class com.amazon.carbonado.qe.QueryEngine (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><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryEngine.html" target="_top">Frames</a></li> +<li><a href="QueryEngine.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.QueryEngine" class="title">Uses of Class<br>com.amazon.carbonado.qe.QueryEngine</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.QueryEngine</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryEngine.html" target="_top">Frames</a></li> +<li><a href="QueryEngine.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html new file mode 100644 index 0000000..2a62831 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutor.html @@ -0,0 +1,331 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.QueryExecutor (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="Uses of Interface com.amazon.carbonado.qe.QueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutor.html" target="_top">Frames</a></li> +<li><a href="QueryExecutor.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.QueryExecutor" class="title">Uses of Interface<br>com.amazon.carbonado.qe.QueryExecutor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which delegates by executing a Query on a Storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and filters results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which utilizes an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps another and sorts the results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#createExecutor()">createExecutor</a></strong>()</code> +<div class="block">Creates a QueryExecutor based on this result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#executor()">executor</a></strong>()</code> +<div class="block">Returns the executor in use by this query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorCache.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)">DelegatedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> rootStorage, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a>> executor)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html#FilteredQueryExecutor(com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.filter.Filter)">FilteredQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a>> filter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(com.amazon.carbonado.qe.QueryExecutor...)">UnionQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>... executors)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructor parameters in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with type arguments of type <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)">UnionQueryExecutor</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>>> executors, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a>> totalOrdering)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutor.html" target="_top">Frames</a></li> +<li><a href="QueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html new file mode 100644 index 0000000..518abde --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorCache.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.QueryExecutorCache (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="Uses of Class com.amazon.carbonado.qe.QueryExecutorCache (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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutorCache.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorCache.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.QueryExecutorCache" class="title">Uses of Class<br>com.amazon.carbonado.qe.QueryExecutorCache</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.QueryExecutorCache</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutorCache.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorCache.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html new file mode 100644 index 0000000..eb00e23 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html @@ -0,0 +1,213 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.QueryExecutorFactory (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="Uses of Interface com.amazon.carbonado.qe.QueryExecutorFactory (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><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorFactory.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.QueryExecutorFactory" class="title">Uses of Interface<br>com.amazon.carbonado.qe.QueryExecutorFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutorFactory which produces executors which delegate via <a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>DelegatedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Complete rule-based query engine implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">QueryExecutors should be cached since expensive analysis is often required to build + them.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Analyzes a query specification and determines how it can be executed as a + union of smaller queries.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#executorFactory()">executorFactory</a></strong>()</code> +<div class="block">Return a QueryExecutorFactory which is used to get an executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><span class="strong">StorageAccess.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html#getQueryExecutorFactory()">getQueryExecutorFactory</a></strong>()</code> +<div class="block">Returns a QueryExecutorFactory instance for storage.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#QueryExecutorCache(com.amazon.carbonado.qe.QueryExecutorFactory)">QueryExecutorCache</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> factory)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html" target="_top">Frames</a></li> +<li><a href="QueryExecutorFactory.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html new file mode 100644 index 0000000..398b758 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryFactory.html @@ -0,0 +1,202 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.QueryFactory (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="Uses of Interface com.amazon.carbonado.qe.QueryFactory (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><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryFactory.html" target="_top">Frames</a></li> +<li><a href="QueryFactory.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.QueryFactory" class="title">Uses of Interface<br>com.amazon.carbonado.qe.QueryFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Complete rule-based query engine implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Builds and caches StandardQuery instances.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#queryFactory()">queryFactory</a></strong>()</code> +<div class="block">Return a QueryFactory which is used to form new queries from this one.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, com.amazon.carbonado.qe.OrderingList)">EmptyQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> ordering)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String...)">EmptyQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String... orderings)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String)">EmptyQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><<a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a>> factory, + java.lang.String ordering)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryFactory.html" target="_top">Frames</a></li> +<li><a href="QueryFactory.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html new file mode 100644 index 0000000..6e78e09 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryHint.html @@ -0,0 +1,208 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.QueryHint (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="Uses of Class com.amazon.carbonado.qe.QueryHint (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><a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryHint.html" target="_top">Frames</a></li> +<li><a href="QueryHint.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.QueryHint" class="title">Uses of Class<br>com.amazon.carbonado.qe.QueryHint</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></code></td> +<td class="colLast"><span class="strong">QueryHint.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHint.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a>[]</code></td> +<td class="colLast"><span class="strong">QueryHint.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHint.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#contains(com.amazon.carbonado.qe.QueryHint)">contains</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns false if hint is not provided.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#get(com.amazon.carbonado.qe.QueryHint)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns null if hint is not provided.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint)">with</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object with the given hint.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)">with</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</code> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#without(com.amazon.carbonado.qe.QueryHint)">without</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryHint.html" target="_top">Frames</a></li> +<li><a href="QueryHint.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html b/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html new file mode 100644 index 0000000..fce4f14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/QueryHints.html @@ -0,0 +1,325 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.QueryHints (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="Uses of Class com.amazon.carbonado.qe.QueryHints (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><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.QueryHints" class="title">Uses of Class<br>com.amazon.carbonado.qe.QueryHints</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#emptyHints()">emptyHints</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint)">with</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object with the given hint.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)">with</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint, + java.lang.Object value)</code> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></code></td> +<td class="colLast"><span class="strong">QueryHints.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html#without(com.amazon.carbonado.qe.QueryHint)">without</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a> hint)</code> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorCache.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor from the cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">DelegatedQueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryExecutorFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns an executor that handles the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#fullComparator(com.amazon.carbonado.qe.QueryHints)">fullComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><?>></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator(com.amazon.carbonado.qe.QueryHints)">localForeignComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">QueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a query that handles the given query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Returns a new or cached query for the given query specification.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/QueryHints.html" target="_top">Frames</a></li> +<li><a href="QueryHints.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html b/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html new file mode 100644 index 0000000..b4d2d7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/RepositoryAccess.html @@ -0,0 +1,186 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.RepositoryAccess (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="Uses of Interface com.amazon.carbonado.qe.RepositoryAccess (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><a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/RepositoryAccess.html" target="_top">Frames</a></li> +<li><a href="RepositoryAccess.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.RepositoryAccess" class="title">Uses of Interface<br>com.amazon.carbonado.qe.RepositoryAccess</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#IndexedQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">IndexedQueryAnalyzer</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>> type, + <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#QueryEngine(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">QueryEngine</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> type, + <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#UnionQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">UnionQueryAnalyzer</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> type, + <a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> access)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/RepositoryAccess.html" target="_top">Frames</a></li> +<li><a href="RepositoryAccess.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html new file mode 100644 index 0000000..e98b2ea --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport (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="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport (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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport" class="title">Uses of Class<br>com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.SortedQueryExecutor.ArraySortSupport</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.ArraySortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html new file mode 100644 index 0000000..b2fe180 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport (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="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport (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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport" class="title">Uses of Class<br>com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.SortedQueryExecutor.MergeSortSupport</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.MergeSortSupport.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html new file mode 100644 index 0000000..5551e27 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html @@ -0,0 +1,193 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.SortedQueryExecutor.Support (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="Uses of Interface com.amazon.carbonado.qe.SortedQueryExecutor.Support (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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.Support.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.SortedQueryExecutor.Support" class="title">Uses of Interface<br>com.amazon.carbonado.qe.SortedQueryExecutor.Support</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides internal access to a <a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> executor, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> handledOrdering, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a>> remainderOrdering)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.Support.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html new file mode 100644 index 0000000..b2bec2a --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.SortedQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.SortedQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.SortedQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/SortedQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="SortedQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html b/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html new file mode 100644 index 0000000..2daf639 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StandardQuery.html @@ -0,0 +1,180 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.StandardQuery (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="Uses of Class com.amazon.carbonado.qe.StandardQuery (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><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StandardQuery.html" target="_top">Frames</a></li> +<li><a href="StandardQuery.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.StandardQuery" class="title">Uses of Class<br>com.amazon.carbonado.qe.StandardQuery</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQueryFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Implement this method to return query implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>></code></td> +<td class="colLast"><span class="strong">QueryEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>></code></td> +<td class="colLast"><span class="strong">StandardQuery.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> values, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StandardQuery.html" target="_top">Frames</a></li> +<li><a href="StandardQuery.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html b/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html new file mode 100644 index 0000000..0c1b2d5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StandardQueryFactory.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.StandardQueryFactory (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="Uses of Class com.amazon.carbonado.qe.StandardQueryFactory (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><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StandardQueryFactory.html" target="_top">Frames</a></li> +<li><a href="StandardQueryFactory.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.StandardQueryFactory" class="title">Uses of Class<br>com.amazon.carbonado.qe.StandardQueryFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Complete rule-based query engine implementation.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StandardQueryFactory.html" target="_top">Frames</a></li> +<li><a href="StandardQueryFactory.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html b/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html new file mode 100644 index 0000000..5de3c10 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StorableIndexSet.html @@ -0,0 +1,159 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.StorableIndexSet (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="Uses of Class com.amazon.carbonado.qe.StorableIndexSet (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><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StorableIndexSet.html" target="_top">Frames</a></li> +<li><a href="StorableIndexSet.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.StorableIndexSet" class="title">Uses of Class<br>com.amazon.carbonado.qe.StorableIndexSet</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)">StorableIndexSet</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> set)</code> +<div class="block">Copy constructor.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StorableIndexSet.html" target="_top">Frames</a></li> +<li><a href="StorableIndexSet.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html b/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html new file mode 100644 index 0000000..a2df0e3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/StorageAccess.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.qe.StorageAccess (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="Uses of Interface com.amazon.carbonado.qe.StorageAccess (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><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StorageAccess.html" target="_top">Frames</a></li> +<li><a href="StorageAccess.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"> +<h2 title="Uses of Interface com.amazon.carbonado.qe.StorageAccess" class="title">Uses of Interface<br>com.amazon.carbonado.qe.StorageAccess</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a><S></code></td> +<td class="colLast"><span class="strong">RepositoryAccess.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html#storageAccessFor(java.lang.Class)">storageAccessFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/StorageAccess.html" target="_top">Frames</a></li> +<li><a href="StorageAccess.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html new file mode 100644 index 0000000..8c63925 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result (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="Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result (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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.Result.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer.Result" class="title">Uses of Class<br>com.amazon.carbonado.qe.UnionQueryAnalyzer.Result</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></code></td> +<td class="colLast"><span class="strong">UnionQueryAnalyzer.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze</a></strong>(<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a>> ordering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.Result.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html new file mode 100644 index 0000000..3e54a03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer (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="Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer (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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.UnionQueryAnalyzer" class="title">Uses of Class<br>com.amazon.carbonado.qe.UnionQueryAnalyzer</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.UnionQueryAnalyzer</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.html" target="_top">Frames</a></li> +<li><a href="UnionQueryAnalyzer.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> diff --git a/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html new file mode 100644 index 0000000..0d3b9cc --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.qe.UnionQueryExecutor (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="Uses of Class com.amazon.carbonado.qe.UnionQueryExecutor (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><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="UnionQueryExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.qe.UnionQueryExecutor" class="title">Uses of Class<br>com.amazon.carbonado.qe.UnionQueryExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.qe.UnionQueryExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/qe/class-use/UnionQueryExecutor.html" target="_top">Frames</a></li> +<li><a href="UnionQueryExecutor.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> diff --git a/apidocs/com/amazon/carbonado/qe/package-frame.html b/apidocs/com/amazon/carbonado/qe/package-frame.html new file mode 100644 index 0000000..e951eaa --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-frame.html @@ -0,0 +1,63 @@ +<!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.qe (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/qe/package-summary.html" target="classFrame">com.amazon.carbonado.qe</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>FullScanQueryExecutor.Support</i></a></li> +<li><a href="IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>IndexedQueryExecutor.Support</i></a></li> +<li><a href="KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>KeyQueryExecutor.Support</i></a></li> +<li><a href="QueryExecutor.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>QueryExecutor</i></a></li> +<li><a href="QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>QueryExecutorFactory</i></a></li> +<li><a href="QueryFactory.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>QueryFactory</i></a></li> +<li><a href="RepositoryAccess.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>RepositoryAccess</i></a></li> +<li><a href="SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>SortedQueryExecutor.Support</i></a></li> +<li><a href="StorageAccess.html" title="interface in com.amazon.carbonado.qe" target="classFrame"><i>StorageAccess</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractQuery.html" title="class in com.amazon.carbonado.qe" target="classFrame">AbstractQuery</a></li> +<li><a href="AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">AbstractQueryExecutor</a></li> +<li><a href="CompositeScore.html" title="class in com.amazon.carbonado.qe" target="classFrame">CompositeScore</a></li> +<li><a href="DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">DelegatedQueryExecutor</a></li> +<li><a href="DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe" target="classFrame">DelegatedQueryExecutorFactory</a></li> +<li><a href="EmptyQuery.html" title="class in com.amazon.carbonado.qe" target="classFrame">EmptyQuery</a></li> +<li><a href="FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">FilteredQueryExecutor</a></li> +<li><a href="FilteringScore.html" title="class in com.amazon.carbonado.qe" target="classFrame">FilteringScore</a></li> +<li><a href="FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">FullScanQueryExecutor</a></li> +<li><a href="IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe" target="classFrame">IndexedQueryAnalyzer</a></li> +<li><a href="IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">IndexedQueryExecutor</a></li> +<li><a href="IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">IterableQueryExecutor</a></li> +<li><a href="JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">JoinedQueryExecutor</a></li> +<li><a href="KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">KeyQueryExecutor</a></li> +<li><a href="OrderingList.html" title="class in com.amazon.carbonado.qe" target="classFrame">OrderingList</a></li> +<li><a href="OrderingScore.html" title="class in com.amazon.carbonado.qe" target="classFrame">OrderingScore</a></li> +<li><a href="QueryEngine.html" title="class in com.amazon.carbonado.qe" target="classFrame">QueryEngine</a></li> +<li><a href="QueryExecutorCache.html" title="class in com.amazon.carbonado.qe" target="classFrame">QueryExecutorCache</a></li> +<li><a href="QueryHints.html" title="class in com.amazon.carbonado.qe" target="classFrame">QueryHints</a></li> +<li><a href="SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">SortedQueryExecutor</a></li> +<li><a href="SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe" target="classFrame">SortedQueryExecutor.ArraySortSupport</a></li> +<li><a href="SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe" target="classFrame">SortedQueryExecutor.MergeSortSupport</a></li> +<li><a href="StandardQuery.html" title="class in com.amazon.carbonado.qe" target="classFrame">StandardQuery</a></li> +<li><a href="StandardQueryFactory.html" title="class in com.amazon.carbonado.qe" target="classFrame">StandardQueryFactory</a></li> +<li><a href="StorableIndexSet.html" title="class in com.amazon.carbonado.qe" target="classFrame">StorableIndexSet</a></li> +<li><a href="UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe" target="classFrame">UnionQueryAnalyzer</a></li> +<li><a href="UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe" target="classFrame">UnionQueryExecutor</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="BoundaryType.html" title="enum in com.amazon.carbonado.qe" target="classFrame">BoundaryType</a></li> +<li><a href="QueryHint.html" title="enum in com.amazon.carbonado.qe" target="classFrame">QueryHint</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/qe/package-summary.html b/apidocs/com/amazon/carbonado/qe/package-summary.html new file mode 100644 index 0000000..94c9d2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-summary.html @@ -0,0 +1,398 @@ +<!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.qe (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.qe (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><a href="../../../../com/amazon/carbonado/lob/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/raw/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/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.qe</h1> +<div class="docSummary"> +<div class="block">Support for implementing a Query Engine.</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/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</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">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</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">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</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">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</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">Performs all the actual work of executing a query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</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">Produces <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</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">Produces <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></td> +<td class="colLast"> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>, necessary for query + execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</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">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</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">Provides internal access to a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</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/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</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">AbstractQuery implements a small set of common Query methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</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">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</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">Evaluates an index for how well it matches a query's desired filtering and + ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</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">QueryExecutor which delegates by executing a Query on a Storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</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">QueryExecutorFactory which produces executors which delegate via <a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>DelegatedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</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">Special query implementation that fetches nothing.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</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">QueryExecutor which wraps another and filters results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</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">Evaluates an index for how well it matches a query's desired filtering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</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">QueryExecutor which fully scans all Storables of a given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</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">Analyzes a simple query specification and determines which index is best + suited for its execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</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">QueryExecutor which utilizes an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</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">QueryExecutor which fully scans an iterable collection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,T extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</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">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</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">Produces unmodifiable lists of <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><code>orderings</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</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">Evaluates an index for how well it matches a query's desired ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</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">Complete rule-based query engine implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</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">QueryExecutors should be cached since expensive analysis is often required to build + them.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></td> +<td class="colLast"> +<div class="block">An immutable map of query hints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</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">QueryExecutor which wraps another and sorts the results.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</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">Abstract query implementation which uses a <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</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">Builds and caches StandardQuery instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</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">Manages a set of <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a> objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of <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/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</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">Analyzes a query specification and determines how it can be executed as a + union of smaller queries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</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">QueryExecutor which wraps several others and unions the results.</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/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></td> +<td class="colLast"> +<div class="block">Describes a value range boundary.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></td> +<td class="colLast"> +<div class="block">Defines a hint key.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.qe Description">Package com.amazon.carbonado.qe Description</h2> +<div class="block">Support for implementing a Query Engine. Repositories are free to use this + package to aid in their implementation, but user-level applications have no + need to use this package.</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><a href="../../../../com/amazon/carbonado/lob/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/raw/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/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> diff --git a/apidocs/com/amazon/carbonado/qe/package-tree.html b/apidocs/com/amazon/carbonado/qe/package-tree.html new file mode 100644 index 0000000..a256965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-tree.html @@ -0,0 +1,223 @@ +<!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.qe Class Hierarchy (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.qe Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/lob/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/raw/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.qe</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.util.AbstractCollection<E> (implements java.util.Collection<E>) +<ul> +<li type="circle">java.util.AbstractList<E> (implements java.util.List<E>) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">OrderingList</span></a><S> (implements java.io.Serializable)</li> +</ul> +</li> +<li type="circle">java.util.AbstractSet<E> (implements java.util.Set<E>) +<ul> +<li type="circle">java.util.TreeSet<E> (implements java.lang.Cloneable, java.util.NavigableSet<E>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">StorableIndexSet</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">AbstractQuery</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><S>) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">EmptyQuery</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">StandardQuery</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">AbstractQueryExecutor</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S>) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">FilteredQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">FullScanQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">IterableQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">JoinedQueryExecutor</span></a><S,T></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">KeyQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryExecutor</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">CompositeScore</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">DelegatedQueryExecutor</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">DelegatedQueryExecutorFactory</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">FilteringScore</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryAnalyzer</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryAnalyzer.Result</span></a></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">OrderingScore</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryExecutorCache</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryHints</span></a> (implements java.io.Serializable)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.ArraySortSupport</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.MergeSortSupport</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">StandardQueryFactory</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a><S>) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryEngine</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryAnalyzer</span></a><S> (implements com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a><S>)</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryAnalyzer.Result</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">FullScanQueryExecutor.Support</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><S> (also extends com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">IndexedQueryExecutor.Support</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><S> (also extends com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">KeyQueryExecutor.Support</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><S> (also extends com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a><S>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryExecutor</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryExecutorFactory</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryFactory</span></a><S></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">RepositoryAccess</span></a></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.Support</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><S> (also extends com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><S>, com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><S>)</li> +</ul> +</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">QueryHint</span></a></li> +<li type="circle">com.amazon.carbonado.qe.<a href="../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">BoundaryType</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/lob/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/raw/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/qe/package-use.html b/apidocs/com/amazon/carbonado/qe/package-use.html new file mode 100644 index 0000000..d198fbe --- /dev/null +++ b/apidocs/com/amazon/carbonado/qe/package-use.html @@ -0,0 +1,265 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.qe (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="Uses of Package com.amazon.carbonado.qe (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.qe" class="title">Uses of Package<br>com.amazon.carbonado.qe</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> used by <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/AbstractQuery.html#com.amazon.carbonado.qe">AbstractQuery</a> +<div class="block">AbstractQuery implements a small set of common Query methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/AbstractQueryExecutor.html#com.amazon.carbonado.qe">AbstractQueryExecutor</a> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/BoundaryType.html#com.amazon.carbonado.qe">BoundaryType</a> +<div class="block">Describes a value range boundary.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/CompositeScore.html#com.amazon.carbonado.qe">CompositeScore</a> +<div class="block">Evaluates an index for how well it matches a query's desired filtering and + ordering.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/FilteringScore.html#com.amazon.carbonado.qe">FilteringScore</a> +<div class="block">Evaluates an index for how well it matches a query's desired filtering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/FullScanQueryExecutor.Support.html#com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/IndexedQueryAnalyzer.Result.html#com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/IndexedQueryExecutor.Support.html#com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/KeyQueryExecutor.Support.html#com.amazon.carbonado.qe">KeyQueryExecutor.Support</a> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/OrderingList.html#com.amazon.carbonado.qe">OrderingList</a> +<div class="block">Produces unmodifiable lists of <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><code>orderings</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/OrderingScore.html#com.amazon.carbonado.qe">OrderingScore</a> +<div class="block">Evaluates an index for how well it matches a query's desired ordering.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryExecutor.html#com.amazon.carbonado.qe">QueryExecutor</a> +<div class="block">Performs all the actual work of executing a query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryExecutorFactory.html#com.amazon.carbonado.qe">QueryExecutorFactory</a> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryFactory.html#com.amazon.carbonado.qe">QueryFactory</a> +<div class="block">Produces <a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> instances from a query specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryHint.html#com.amazon.carbonado.qe">QueryHint</a> +<div class="block">Defines a hint key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/QueryHints.html#com.amazon.carbonado.qe">QueryHints</a> +<div class="block">An immutable map of query hints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/RepositoryAccess.html#com.amazon.carbonado.qe">RepositoryAccess</a> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>, necessary for query + execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/SortedQueryExecutor.Support.html#com.amazon.carbonado.qe">SortedQueryExecutor.Support</a> +<div class="block">Provides support for <a href="../../../../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/StandardQuery.html#com.amazon.carbonado.qe">StandardQuery</a> +<div class="block">Abstract query implementation which uses a <a href="../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/StandardQueryFactory.html#com.amazon.carbonado.qe">StandardQueryFactory</a> +<div class="block">Builds and caches StandardQuery instances.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/StorableIndexSet.html#com.amazon.carbonado.qe">StorableIndexSet</a> +<div class="block">Manages a set of <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a> objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/StorageAccess.html#com.amazon.carbonado.qe">StorageAccess</a> +<div class="block">Provides internal access to a <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/qe/class-use/UnionQueryAnalyzer.Result.html#com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/qe/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html new file mode 100644 index 0000000..93dedfd --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressedEncodingStrategy.html @@ -0,0 +1,352 @@ +<!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>CompressedEncodingStrategy (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="CompressedEncodingStrategy (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/CompressedEncodingStrategy.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.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/CompressedEncodingStrategy.html" target="_top">Frames</a></li> +<li><a href="CompressedEncodingStrategy.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><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 CompressedEncodingStrategy" class="title">Class CompressedEncodingStrategy<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><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">com.amazon.carbonado.raw.GenericEncodingStrategy</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.CompressedEncodingStrategy<S></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">CompressedEncodingStrategy<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></pre> +<div class="block">Extension of GenericEncodingStrategy that allows for compression.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Olga Kuznetsova, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/CompressedEncodingStrategy.html#CompressedEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.raw.CompressionType)">CompressedEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> pkIndex, + <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> compressionType)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#extraDataDecoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataDecoding</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix)</code> +<div class="block">Second phase decoding, which does nothing by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#extraDataEncoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataEncoding</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix)</code> +<div class="block">Second phase encoding, which does nothing by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.raw.GenericEncodingStrategy"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></h3> +<code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)">buildDataDecoding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int)">buildDataEncoding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable)">buildKeyDecoding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable, org.cojen.classfile.LocalVariable)">buildKeyEncoding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable)">buildSerialDecoding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[])">buildSerialEncoding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty)">checkSupport</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty[])">checkSupport</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllDataProperties()">gatherAllDataProperties</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllKeyProperties()">gatherAllKeyProperties</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllProperties()">gatherAllProperties</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getConstantKeyPrefixLength()">getConstantKeyPrefixLength</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getDataPrefixPadding()">getDataPrefixPadding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getDataSuffixPadding()">getDataSuffixPadding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getKeyPrefixPadding()">getKeyPrefixPadding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getKeySuffixPadding()">getKeySuffixPadding</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getType()">getType</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#isSupported(java.lang.Class)">isSupported</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#isSupported(org.cojen.classfile.TypeDesc)">isSupported</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#loadPropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)">loadPropertyValue</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#loadPropertyValue(org.cojen.classfile.LocalVariable[], java.lang.Boolean[], org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)">loadPropertyValue</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#pushDecodingInstanceVar(org.cojen.classfile.CodeAssembler, int, org.cojen.classfile.LocalVariable)">pushDecodingInstanceVar</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#pushRawSupport(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable)">pushRawSupport</a>, <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#storePropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, boolean, org.cojen.classfile.LocalVariable, java.lang.Class)">storePropertyValue</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</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="CompressedEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.raw.CompressionType)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CompressedEncodingStrategy</h4> +<pre>public CompressedEncodingStrategy(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> pkIndex, + <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> compressionType)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="extraDataEncoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>extraDataEncoding</h4> +<pre>protected void extraDataEncoding(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#extraDataEncoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">GenericEncodingStrategy</a></code></strong></div> +<div class="block">Second phase encoding, which does nothing by default.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#extraDataEncoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataEncoding</a></code> in class <code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>dataVar</code> - local variable referencing a byte array with data</dd><dd><code>prefix</code> - prefix of byte array to preserve</dd><dd><code>suffix</code> - suffix of byte array to preserve</dd></dl> +</li> +</ul> +<a name="extraDataDecoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>extraDataDecoding</h4> +<pre>protected void extraDataDecoding(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#extraDataDecoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">GenericEncodingStrategy</a></code></strong></div> +<div class="block">Second phase decoding, which does nothing by default.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#extraDataDecoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataDecoding</a></code> in class <code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dd><code>dataVar</code> - local variable referencing a byte array with data</dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">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="hashCode()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#hashCode()">hashCode</a></code> in class <code><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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/CompressedEncodingStrategy.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.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/CompressedEncodingStrategy.html" target="_top">Frames</a></li> +<li><a href="CompressedEncodingStrategy.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html new file mode 100644 index 0000000..f456422 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressedStorableCodecFactory.html @@ -0,0 +1,329 @@ +<!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>CompressedStorableCodecFactory (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="CompressedStorableCodecFactory (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/CompressedStorableCodecFactory.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/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum 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/CompressedStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="CompressedStorableCodecFactory.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><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 CompressedStorableCodecFactory" class="title">Class CompressedStorableCodecFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">com.amazon.carbonado.raw.GenericStorableCodecFactory</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.CompressedStorableCodecFactory</li> +</ul> +</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/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">CompressedStorableCodecFactory</span> +extends <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></pre> +<div class="block">Extension of GenericStorableCodecFactory that allows for compression.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Olga Kuznetsova, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/CompressedStorableCodecFactory.html#CompressedStorableCodecFactory(java.util.Map)">CompressedStorableCodecFactory</a></strong>(java.util.Map<java.lang.String,<a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>> compressionMap)</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>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getCompressionType(java.lang.Class)">getCompressionType</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.raw.GenericStorableCodecFactory"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></h3> +<code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a>, <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a>, <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">createStrategy</a>, <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></code></li> +</ul> +<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> +</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="CompressedStorableCodecFactory(java.util.Map)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CompressedStorableCodecFactory</h4> +<pre>public CompressedStorableCodecFactory(java.util.Map<java.lang.String,<a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>> compressionMap)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getLayoutOptions(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLayoutOptions</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> getLayoutOptions(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">GenericStorableCodecFactory</a></code></strong></div> +<div class="block">Returns null.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></code> in class <code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></code></dd> +</dl> +</li> +</ul> +<a name="createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStrategy</h4> +<pre>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S> createStrategy(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">GenericStorableCodecFactory</a></code></strong></div> +<div class="block">Override to return a different EncodingStrategy.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></code> in class <code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable to generate code for</dd><dd><code>pkIndex</code> - specifies sequence and ordering of key properties (optional)</dd><dd><code>options</code> - additional layout options (optional)</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></dd></dl> +</li> +</ul> +<a name="getCompressionType(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCompressionType</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> getCompressionType(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>non-null compression type for the given storable</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/CompressedStorableCodecFactory.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/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum 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/CompressedStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="CompressedStorableCodecFactory.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/CompressionType.html b/apidocs/com/amazon/carbonado/raw/CompressionType.html new file mode 100644 index 0000000..2c5c5f3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CompressionType.html @@ -0,0 +1,332 @@ +<!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>CompressionType (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="CompressionType (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/CompressionType.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/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.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/CompressionType.html" target="_top">Frames</a></li> +<li><a href="CompressionType.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum CompressionType" class="title">Enum CompressionType</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.CompressionType</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">CompressionType</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>></pre> +<div class="block">Available compression types for any particular storable.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Olga Kuznetsova</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressionType.html#GZIP">GZIP</a></strong></code> +<div class="block">Gzip compression.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressionType.html#NONE">NONE</a></strong></code> +<div class="block">No compression.</div> +</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>static <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressionType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CompressionType.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="NONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NONE</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> NONE</pre> +<div class="block">No compression.</div> +</li> +</ul> +<a name="GZIP"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GZIP</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> GZIP</pre> +<div class="block">Gzip compression.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (CompressionType c : CompressionType.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/CompressionType.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/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.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/CompressionType.html" target="_top">Frames</a></li> +<li><a href="CompressionType.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html new file mode 100644 index 0000000..14fe739 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html @@ -0,0 +1,236 @@ +<!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.InstanceFactory (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.InstanceFactory (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.InstanceFactory.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/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.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/CustomStorableCodec.InstanceFactory.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodec.InstanceFactory.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 CustomStorableCodec.InstanceFactory" class="title">Interface CustomStorableCodec.InstanceFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</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>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">CustomStorableCodec.InstanceFactory</span></pre> +</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><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[], com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key, + byte[] value, + <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +</table> +</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="instantiate(com.amazon.carbonado.raw.RawSupport, com.amazon.carbonado.raw.CustomStorableCodec)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</pre> +</li> +</ul> +<a name="instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[], com.amazon.carbonado.raw.CustomStorableCodec)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key, + byte[] value, + <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><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> +</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.InstanceFactory.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/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.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/CustomStorableCodec.InstanceFactory.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodec.InstanceFactory.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> 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> diff --git a/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html new file mode 100644 index 0000000..a5a6d9b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/CustomStorableCodecFactory.html @@ -0,0 +1,386 @@ +<!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>CustomStorableCodecFactory (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="CustomStorableCodecFactory (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/CustomStorableCodecFactory.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/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/DataDecoder.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/CustomStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodecFactory.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><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 CustomStorableCodecFactory" class="title">Class CustomStorableCodecFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.CustomStorableCodecFactory</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/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">CustomStorableCodecFactory</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></pre> +<div class="block">Factory for custom storable codecs.</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"> +<!-- ======== 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/CustomStorableCodecFactory.html#CustomStorableCodecFactory()">CustomStorableCodecFactory</a></strong>()</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>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null to let repository decide what the name should be.</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.StorableCodecFactory"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></h3> +<code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</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="CustomStorableCodecFactory()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CustomStorableCodecFactory</h4> +<pre>public CustomStorableCodecFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorageName(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageName</h4> +<pre>public java.lang.String getStorageName(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Returns null to let repository decide what the name should be.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></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 type is not supported</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createCodec</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S> createCodec(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to create codec for</dd><dd><code>pkIndex</code> - ignored</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, attempt to encode a storable layout + generation value in each storable</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 type is not supported</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createCodec</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S> createCodec(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to create codec for</dd><dd><code>pkIndex</code> - ignored</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, attempt to encode a storable layout + generation value in each storable</dd><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/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if type is not supported</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createCodec</h4> +<pre>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S> createCodec(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout) + 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>type</code> - type of storable to create codec for</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, attempt to encode a storable layout + generation value in each storable</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 type is not supported</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createCodec</h4> +<pre>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S> createCodec(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</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>type</code> - type of storable to create codec for</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, attempt to encode a storable layout + generation value in each storable</dd><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/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if type is not supported</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</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/CustomStorableCodecFactory.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/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/DataDecoder.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/CustomStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodecFactory.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/DataDecoder.html b/apidocs/com/amazon/carbonado/raw/DataDecoder.html new file mode 100644 index 0000000..d9c7e29 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/DataDecoder.html @@ -0,0 +1,879 @@ +<!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>DataDecoder (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="DataDecoder (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/DataDecoder.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/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/DataEncoder.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/DataDecoder.html" target="_top">Frames</a></li> +<li><a href="DataDecoder.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><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 DataDecoder" class="title">Class DataDecoder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.DataDecoder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DataDecoder</span> +extends java.lang.Object</pre> +<div class="block">A very low-level class that decodes key components encoded by methods of + <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw"><code>DataEncoder</code></a>.</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/KeyDecoder.html" title="class in com.amazon.carbonado.raw"><code>KeyDecoder</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/DataDecoder.html#DataDecoder()">DataDecoder</a></strong>()</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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, java.math.BigDecimal[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef)</code> +<div class="block">Decodes a BigDecimal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, java.math.BigInteger[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef)</code> +<div class="block">Decodes a BigInteger.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, byte[][])">decode</a></strong>(byte[] src, + int srcOffset, + byte[][] valueRef)</code> +<div class="block">Decodes the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeBoolean(byte[], int)">decodeBoolean</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a boolean from exactly 1 byte.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeBooleanObj(byte[], int)">decodeBooleanObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Boolean object from exactly 1 byte.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeByte(byte[], int)">decodeByte</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed byte from exactly 1 byte.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Byte</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeByteObj(byte[], int)">decodeByteObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeChar(byte[], int)">decodeChar</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a char from exactly 2 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Character</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeCharacterObj(byte[], int)">decodeCharacterObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static double</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDouble(byte[], int)">decodeDouble</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a double from exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDoubleBits(byte[], int)">decodeDoubleBits</a></strong>(byte[] src, + int srcOffset)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Double</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeDoubleObj(byte[], int)">decodeDoubleObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloat(byte[], int)">decodeFloat</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a float from exactly 4 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloatBits(byte[], int)">decodeFloatBits</a></strong>(byte[] src, + int srcOffset)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Float</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeFloatObj(byte[], int)">decodeFloatObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeInt(byte[], int)">decodeInt</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed integer from exactly 4 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeIntegerObj(byte[], int)">decodeIntegerObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeLong(byte[], int)">decodeLong</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed long from exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeLongObj(byte[], int)">decodeLongObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static short</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeShort(byte[], int)">decodeShort</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed short from exactly 2 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Short</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeShortObj(byte[], int)">decodeShortObj</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingle(byte[], int, int)">decodeSingle</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)"><code>DataEncoder.encodeSingle(byte[], int, int)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingleNullable(byte[])">decodeSingleNullable</a></strong>(byte[] src)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeSingleNullable(byte[], int, int)">decodeSingleNullable</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#decodeString(byte[], int, java.lang.String[])">decodeString</a></strong>(byte[] src, + int srcOffset, + java.lang.String[] valueRef)</code> +<div class="block">Decodes an encoded string from the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#readFully(java.io.InputStream, byte[])">readFully</a></strong>(java.io.InputStream in, + byte[] b)</code> +<div class="block">Reads as many bytes from the stream as is necessary to fill the given + byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html#readLength(java.io.InputStream)">readLength</a></strong>(java.io.InputStream in)</code> +<div class="block">Decodes a length value which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#writeLength(int, java.io.OutputStream)"><code>DataEncoder.writeLength(int, java.io.OutputStream)</code></a>.</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> +</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="DataDecoder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataDecoder</h4> +<pre>public DataDecoder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="decodeInt(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeInt</h4> +<pre>public static int decodeInt(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed integer from exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed integer value</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></dd></dl> +</li> +</ul> +<a name="decodeIntegerObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeIntegerObj</h4> +<pre>public static java.lang.Integer decodeIntegerObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Integer object or null</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></dd></dl> +</li> +</ul> +<a name="decodeLong(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeLong</h4> +<pre>public static long decodeLong(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed long from exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed long value</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></dd></dl> +</li> +</ul> +<a name="decodeLongObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeLongObj</h4> +<pre>public static java.lang.Long decodeLongObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Long object or null</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></dd></dl> +</li> +</ul> +<a name="decodeByte(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeByte</h4> +<pre>public static byte decodeByte(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed byte from exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed byte value</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></dd></dl> +</li> +</ul> +<a name="decodeByteObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeByteObj</h4> +<pre>public static java.lang.Byte decodeByteObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Byte object or null</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></dd></dl> +</li> +</ul> +<a name="decodeShort(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeShort</h4> +<pre>public static short decodeShort(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed short from exactly 2 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed short value</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></dd></dl> +</li> +</ul> +<a name="decodeShortObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeShortObj</h4> +<pre>public static java.lang.Short decodeShortObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Short object or null</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></dd></dl> +</li> +</ul> +<a name="decodeChar(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeChar</h4> +<pre>public static char decodeChar(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a char from exactly 2 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>char value</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></dd></dl> +</li> +</ul> +<a name="decodeCharacterObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeCharacterObj</h4> +<pre>public static java.lang.Character decodeCharacterObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes. If null is + returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Character object or null</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></dd></dl> +</li> +</ul> +<a name="decodeBoolean(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeBoolean</h4> +<pre>public static boolean decodeBoolean(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a boolean from exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>boolean value</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></dd></dl> +</li> +</ul> +<a name="decodeBooleanObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeBooleanObj</h4> +<pre>public static java.lang.Boolean decodeBooleanObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Boolean object from exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Boolean object or null</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></dd></dl> +</li> +</ul> +<a name="decodeFloat(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeFloat</h4> +<pre>public static float decodeFloat(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a float from exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>float value</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></dd></dl> +</li> +</ul> +<a name="decodeFloatObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeFloatObj</h4> +<pre>public static java.lang.Float decodeFloatObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Float object or null</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></dd></dl> +</li> +</ul> +<a name="decodeFloatBits(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeFloatBits</h4> +<pre>protected static int decodeFloatBits(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<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="decodeDouble(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDouble</h4> +<pre>public static double decodeDouble(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a double from exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>double value</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></dd></dl> +</li> +</ul> +<a name="decodeDoubleObj(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDoubleObj</h4> +<pre>public static java.lang.Double decodeDoubleObj(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Double object or null</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></dd></dl> +</li> +</ul> +<a name="decodeDoubleBits(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDoubleBits</h4> +<pre>protected static long decodeDoubleBits(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<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="decode(byte[], int, java.math.BigInteger[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a BigInteger.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded BigInteger is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decode(byte[], int, java.math.BigDecimal[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a BigDecimal.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded BigDecimal is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decode(byte[], int, byte[][])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + byte[][] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded byte array is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd></dl> +</li> +</ul> +<a name="decodeString(byte[], int, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeString</h4> +<pre>public static int decodeString(byte[] src, + int srcOffset, + java.lang.String[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes an encoded string from the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded string is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd></dl> +</li> +</ul> +<a name="readLength(java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readLength</h4> +<pre>public static int readLength(java.io.InputStream in) + throws java.io.IOException, + java.io.EOFException</pre> +<div class="block">Decodes a length value which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#writeLength(int, java.io.OutputStream)"><code>DataEncoder.writeLength(int, java.io.OutputStream)</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>length value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code>java.io.EOFException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="readFully(java.io.InputStream, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFully</h4> +<pre>public static void readFully(java.io.InputStream in, + byte[] b) + throws java.io.IOException, + java.io.EOFException</pre> +<div class="block">Reads as many bytes from the stream as is necessary to fill the given + byte array. An EOFException is thrown if the stream end is encountered.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code>java.io.EOFException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decodeSingle(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeSingle</h4> +<pre>public static byte[] decodeSingle(byte[] src, + int prefixPadding, + int suffixPadding) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)"><code>DataEncoder.encodeSingle(byte[], int, int)</code></a>. Always returns a new byte array instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to skip from start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to skip at end of encoded byte array</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></dd></dl> +</li> +</ul> +<a name="decodeSingleNullable(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeSingleNullable</h4> +<pre>public static byte[] decodeSingleNullable(byte[] src) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>. Always returns a new byte array + instance.</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="decodeSingleNullable(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decodeSingleNullable</h4> +<pre>public static byte[] decodeSingleNullable(byte[] src, + int prefixPadding, + int suffixPadding) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>. Always returns a new byte array + instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to skip from start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to skip at end of encoded byte array</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></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/DataDecoder.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/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/DataEncoder.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/DataDecoder.html" target="_top">Frames</a></li> +<li><a href="DataDecoder.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/DataEncoder.html b/apidocs/com/amazon/carbonado/raw/DataEncoder.html new file mode 100644 index 0000000..553433e --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/DataEncoder.html @@ -0,0 +1,920 @@ +<!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>DataEncoder (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="DataEncoder (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/DataEncoder.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/DataDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.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/DataEncoder.html" target="_top">Frames</a></li> +<li><a href="DataEncoder.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><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 DataEncoder" class="title">Class DataEncoder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.DataEncoder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DataEncoder</span> +extends java.lang.Object</pre> +<div class="block">A very low-level class that supports encoding of primitive data. For + encoding data into keys, see <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><code>KeyEncoder</code></a>.</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/DataDecoder.html" title="class in com.amazon.carbonado.raw"><code>DataDecoder</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/DataEncoder.html#DataEncoder()">DataEncoder</a></strong>()</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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(java.math.BigDecimal)">calculateEncodedLength</a></strong>(java.math.BigDecimal value)</code> +<div class="block">Returns the amount of bytes required to encode the given BigDecimal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(java.math.BigInteger)">calculateEncodedLength</a></strong>(java.math.BigInteger value)</code> +<div class="block">Returns the amount of bytes required to encode the given BigInteger.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(byte[])">calculateEncodedLength</a></strong>(byte[] value)</code> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(byte[], int, int)">calculateEncodedLength</a></strong>(byte[] value, + int valueOffset, + int valueLength)</code> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedStringLength(java.lang.String)">calculateEncodedStringLength</a></strong>(java.lang.String value)</code> +<div class="block">Returns the amount of bytes required to encode the given String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.math.BigDecimal, byte[], int)">encode</a></strong>(java.math.BigDecimal value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional BigDecimal into a variable amount of + bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.math.BigInteger, byte[], int)">encode</a></strong>(java.math.BigInteger value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional BigInteger into a variable amount of + bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(boolean, byte[], int)">encode</a></strong>(boolean value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given boolean into exactly 1 byte.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Boolean, byte[], int)">encode</a></strong>(java.lang.Boolean value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Boolean object into exactly 1 byte.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(byte[], byte[], int)">encode</a></strong>(byte[] value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(byte[], int, int, byte[], int)">encode</a></strong>(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(byte, byte[], int)">encode</a></strong>(byte value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed byte into exactly 1 byte.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Byte, byte[], int)">encode</a></strong>(java.lang.Byte value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Character, byte[], int)">encode</a></strong>(java.lang.Character value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Character object into exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(char, byte[], int)">encode</a></strong>(char value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given character into exactly 2 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(double, byte[], int)">encode</a></strong>(double value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given double into exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Double, byte[], int)">encode</a></strong>(java.lang.Double value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Double object into exactly 8 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(float, byte[], int)">encode</a></strong>(float value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given float into exactly 4 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Float, byte[], int)">encode</a></strong>(java.lang.Float value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Float object into exactly 4 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(int, byte[], int)">encode</a></strong>(int value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed integer into exactly 4 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Integer, byte[], int)">encode</a></strong>(java.lang.Integer value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(long, byte[], int)">encode</a></strong>(long value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed long into exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Long, byte[], int)">encode</a></strong>(java.lang.Long value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(short, byte[], int)">encode</a></strong>(short value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed short into exactly 2 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Short, byte[], int)">encode</a></strong>(java.lang.Short value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.String, byte[], int)">encode</a></strong>(java.lang.String value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional String into a variable amount of bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)">encodeSingle</a></strong>(byte[] value, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Encodes the given byte array for use when there is only a single + property, whose type is a byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])">encodeSingleNullable</a></strong>(byte[] value)</code> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[], int, int)">encodeSingleNullable</a></strong>(byte[] value, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html#writeLength(int, java.io.OutputStream)">writeLength</a></strong>(int valueLength, + java.io.OutputStream out)</code> +<div class="block">Writes a positive length value in up to five bytes.</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> +</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="DataEncoder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DataEncoder</h4> +<pre>public DataEncoder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="encode(int, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(int value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed integer into exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed integer value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Integer, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Integer value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes. If + the Integer object is never expected to be null, consider encoding as an + int primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Integer value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(long, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(long value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed long into exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed long value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Long, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Long value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes. If the + Long object is never expected to be null, consider encoding as a long + primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Long value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(byte, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(byte value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed byte into exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed byte value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Byte, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Byte value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes. If the + Byte object is never expected to be null, consider encoding as a byte + primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Byte value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(short, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(short value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed short into exactly 2 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed short value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Short, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Short value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes. If the + Short object is never expected to be null, consider encoding as a short + primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Short value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(char, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(char value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given character into exactly 2 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - character value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Character, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.Character value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Character object into exactly 1 or 3 bytes. If the + Character object is never expected to be null, consider encoding as a + char primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Character value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(boolean, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(boolean value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given boolean into exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - boolean value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Boolean, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(java.lang.Boolean value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Boolean object into exactly 1 byte.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Boolean value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(float, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(float value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given float into exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - float value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Float, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(java.lang.Float value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Float object into exactly 4 bytes. A non-canonical NaN + value is used to represent null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Float value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(double, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(double value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given double into exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - double value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.lang.Double, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static void encode(java.lang.Double value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Double object into exactly 8 bytes. A non-canonical + NaN value is used to represent null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Double value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.math.BigInteger, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.math.BigInteger value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional BigInteger into a variable amount of + bytes. If the BigInteger is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(java.math.BigInteger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(java.math.BigInteger value)</pre> +<div class="block">Returns the amount of bytes required to encode the given BigInteger.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encode(java.math.BigDecimal, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.math.BigDecimal value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional BigDecimal into a variable amount of + bytes. If the BigDecimal is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(java.math.BigDecimal)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(java.math.BigDecimal value)</pre> +<div class="block">Returns the amount of bytes required to encode the given BigDecimal.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encode(byte[], byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(byte[] value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(byte[], int, int, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(byte[] value)</pre> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(byte[] value, + int valueOffset, + int valueLength)</pre> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd></dl> +</li> +</ul> +<a name="encode(java.lang.String, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.String value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional String into a variable amount of bytes. The + amount written can be determined by calling + calculateEncodedStringLength. + <p> + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are written in one byte. This encoding is more efficient than + UTF-8, but it isn't compatible with UTF-8.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="calculateEncodedStringLength(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedStringLength</h4> +<pre>public static int calculateEncodedStringLength(java.lang.String value)</pre> +<div class="block">Returns the amount of bytes required to encode the given String.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String to encode, may be null</dd></dl> +</li> +</ul> +<a name="writeLength(int, java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeLength</h4> +<pre>public static int writeLength(int valueLength, + java.io.OutputStream out) + throws java.io.IOException</pre> +<div class="block">Writes a positive length value in up to five bytes.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>number of bytes written</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encodeSingle(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSingle</h4> +<pre>public static byte[] encodeSingle(byte[] value, + int prefixPadding, + int suffixPadding)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + property, whose type is a byte array. The original byte array is + returned if the padding lengths are zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to allocate at start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to allocate at end of encoded byte array</dd></dl> +</li> +</ul> +<a name="encodeSingleNullable(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSingleNullable</h4> +<pre>public static byte[] encodeSingleNullable(byte[] value)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</div> +</li> +</ul> +<a name="encodeSingleNullable(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>encodeSingleNullable</h4> +<pre>public static byte[] encodeSingleNullable(byte[] value, + int prefixPadding, + int suffixPadding)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to allocate at start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to allocate at end of encoded byte array</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/DataEncoder.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/DataDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.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/DataEncoder.html" target="_top">Frames</a></li> +<li><a href="DataEncoder.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html new file mode 100644 index 0000000..9e13630 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericEncodingStrategy.html @@ -0,0 +1,1000 @@ +<!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>GenericEncodingStrategy (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="GenericEncodingStrategy (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/GenericEncodingStrategy.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/DataEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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/GenericEncodingStrategy.html" target="_top">Frames</a></li> +<li><a href="GenericEncodingStrategy.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><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 GenericEncodingStrategy" class="title">Class GenericEncodingStrategy<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.GenericEncodingStrategy<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">GenericEncodingStrategy<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes. + + <p>Note: subclasses must override and specialize the hashCode and equals + methods. Failure to do so interferes with <a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodecFactory</code></a>'s + generated code cache.</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"> +<!-- ======== 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/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">GenericEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> pkIndex)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, int, int, int, int)">GenericEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> pkIndex, + int keyPrefixPadding, + int keySuffixPadding, + int dataPrefixPadding, + int dataSuffixPadding)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)">buildDataDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + int generation, + org.cojen.classfile.Label altGenerationHandler, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int)">buildDataEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + int generation)</code> +<div class="block">Generates bytecode instructions to encode properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable)">buildKeyDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable, org.cojen.classfile.LocalVariable)">buildKeyEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + org.cojen.classfile.LocalVariable partialStartVar, + org.cojen.classfile.LocalVariable partialEndVar)</code> +<div class="block">Generates bytecode instructions to encode properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable)">buildSerialDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties and their states.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[])">buildSerialEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> +<div class="block">Generates bytecode instructions to encode properties and their + states.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty)">checkSupport</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> property)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty[])">checkSupport</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#extraDataDecoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataDecoding</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix)</code> +<div class="block">Second phase decoding, which does nothing by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#extraDataEncoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataEncoding</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix)</code> +<div class="block">Second phase encoding, which does nothing by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllDataProperties()">gatherAllDataProperties</a></strong>()</code> +<div class="block">Returns all non-derived data properties for storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllKeyProperties()">gatherAllKeyProperties</a></strong>()</code> +<div class="block">Returns all key properties as ordered properties, possibly with + unspecified directions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllProperties()">gatherAllProperties</a></strong>()</code> +<div class="block">Returns all non-join, non-derived properties for storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getConstantKeyPrefixLength()">getConstantKeyPrefixLength</a></strong>()</code> +<div class="block">Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getDataPrefixPadding()">getDataPrefixPadding</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getDataSuffixPadding()">getDataSuffixPadding</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getKeyPrefixPadding()">getKeyPrefixPadding</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getKeySuffixPadding()">getKeySuffixPadding</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> +<div class="block">Returns all key properties in the form of an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getType()">getType</a></strong>()</code> +<div class="block">Returns the type of Storable that code is generated for.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#isSupported(java.lang.Class)">isSupported</a></strong>(java.lang.Class<?> propertyType)</code> +<div class="block">Returns true if the type of the given property type is supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#isSupported(org.cojen.classfile.TypeDesc)">isSupported</a></strong>(org.cojen.classfile.TypeDesc propertyType)</code> +<div class="block">Returns true if the type of the given property type is supported.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#loadPropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)">loadPropertyValue</a></strong>(org.cojen.classfile.CodeAssembler a, + <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar)</code> +<div class="block">Generates code to load a property value onto the operand stack.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#loadPropertyValue(org.cojen.classfile.LocalVariable[], java.lang.Boolean[], org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)">loadPropertyValue</a></strong>(org.cojen.classfile.LocalVariable[] stashedProperties, + java.lang.Boolean[] stashedFromInstances, + org.cojen.classfile.CodeAssembler a, + <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar)</code> +<div class="block">Generates code to load a property value onto the operand stack.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#pushDecodingInstanceVar(org.cojen.classfile.CodeAssembler, int, org.cojen.classfile.LocalVariable)">pushDecodingInstanceVar</a></strong>(org.cojen.classfile.CodeAssembler a, + int ordinal, + org.cojen.classfile.LocalVariable instanceVar)</code> +<div class="block">Push decoding instanceVar to stack in preparation to calling + storePropertyValue.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#pushRawSupport(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable)">pushRawSupport</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable instanceVar)</code> +<div class="block">Generates code to push RawSupport instance to the stack.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#storePropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, boolean, org.cojen.classfile.LocalVariable, java.lang.Class)">storePropertyValue</a></strong>(org.cojen.classfile.CodeAssembler a, + <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + boolean useWriteMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass)</code> +<div class="block">Generates code to store a property value into an instance which is + already on the operand stack.</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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</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="GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GenericEncodingStrategy</h4> +<pre>public GenericEncodingStrategy(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> pkIndex)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable to generate code for</dd><dd><code>pkIndex</code> - specifies sequence and ordering of key properties (optional)</dd></dl> +</li> +</ul> +<a name="GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GenericEncodingStrategy</h4> +<pre>public GenericEncodingStrategy(java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> pkIndex, + int keyPrefixPadding, + int keySuffixPadding, + int dataPrefixPadding, + int dataSuffixPadding)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable to generate code for</dd><dd><code>pkIndex</code> - specifies sequence and ordering of key properties (optional)</dd><dd><code>keyPrefixPadding</code> - amount of padding bytes at start of keys</dd><dd><code>keySuffixPadding</code> - amount of padding bytes at end of keys</dd><dd><code>dataPrefixPadding</code> - amount of padding bytes at start of data values</dd><dd><code>dataSuffixPadding</code> - amount of padding bytes at end of data values</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="buildKeyEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable, org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildKeyEncoding</h4> +<pre>public org.cojen.classfile.LocalVariable buildKeyEncoding(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + org.cojen.classfile.LocalVariable partialStartVar, + org.cojen.classfile.LocalVariable partialEndVar) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates bytecode instructions to encode properties. The encoding is + suitable for "key" encoding, which means it is correctly comparable. + + <p>Note: if a partialStartVar is provided and this strategy has a key + prefix, the prefix is allocated only if the runtime value of + partialStartVar is zero. Likewise, if a partialEndVar is provided and + this strategy has a key suffix, the suffix is allocated only of the + runtime value of partialEndVar is one less than the property count.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>assembler</code> - code assembler to receive bytecode instructions</dd><dd><code>properties</code> - specific properties to encode, defaults to all key + properties if null</dd><dd><code>instanceVar</code> - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.</dd><dd><code>adapterInstanceClass</code> - class containing static references to + adapter instances - defaults to instanceVar</dd><dd><code>useReadMethods</code> - when true, access properties by public read + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields</dd><dd><code>partialStartVar</code> - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.</dd><dd><code>partialEndVar</code> - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than or + equal to the properties array length. It marks the range end (exclusive) + of the partial property range.</dd> +<dt><span class="strong">Returns:</span></dt><dd>local variable referencing a byte array with encoded key</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 any property type is not supported</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if assembler is null, or if instanceVar + is not the correct instance type, or if partial variable types are not + ints</dd></dl> +</li> +</ul> +<a name="buildKeyDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildKeyDecoding</h4> +<pre>public void buildKeyDecoding(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + org.cojen.classfile.LocalVariable encodedVar) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates bytecode instructions to decode properties. A + CorruptEncodingException may be thrown from generated code.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>assembler</code> - code assembler to receive bytecode instructions</dd><dd><code>properties</code> - specific properties to decode, defaults to all key + properties if null</dd><dd><code>instanceVar</code> - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are placed into the runtime value of this array instead + of a Storable instance.</dd><dd><code>adapterInstanceClass</code> - class containing static references to + adapter instances - defaults to instanceVar</dd><dd><code>useWriteMethods</code> - when true, set properties by public write + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields</dd><dd><code>encodedVar</code> - required variable, which must be a byte array. At + runtime, it references an encoded key.</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 any property type is not supported</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if assembler is null, or if instanceVar + is not the correct instance type, or if encodedVar is not a byte array</dd></dl> +</li> +</ul> +<a name="buildDataEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildDataEncoding</h4> +<pre>public org.cojen.classfile.LocalVariable buildDataEncoding(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + int generation) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates bytecode instructions to encode properties. The encoding is + suitable for "data" encoding, which means it is not correctly + comparable, but it is more efficient than key encoding. Partial encoding + is not supported.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>assembler</code> - code assembler to receive bytecode instructions</dd><dd><code>properties</code> - specific properties to encode, defaults to all non-key + properties if null</dd><dd><code>instanceVar</code> - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.</dd><dd><code>adapterInstanceClass</code> - class containing static references to + adapter instances - defaults to instanceVar</dd><dd><code>useReadMethods</code> - when true, access properties by public read + methods instead of protected fields</dd><dd><code>generation</code> - when non-negative, write a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.</dd> +<dt><span class="strong">Returns:</span></dt><dd>local variable referencing a byte array with encoded data</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 any property type is not supported</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if assembler is null, or if instanceVar + is not the correct instance type</dd></dl> +</li> +</ul> +<a name="buildDataDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildDataDecoding</h4> +<pre>public void buildDataDecoding(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + int generation, + org.cojen.classfile.Label altGenerationHandler, + org.cojen.classfile.LocalVariable encodedVar) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates bytecode instructions to decode properties. A + CorruptEncodingException may be thrown from generated code.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>assembler</code> - code assembler to receive bytecode instructions</dd><dd><code>properties</code> - specific properties to decode, defaults to all non-key + properties if null</dd><dd><code>instanceVar</code> - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are placed into the runtime value of this array instead + of a Storable instance.</dd><dd><code>adapterInstanceClass</code> - class containing static references to + adapter instances - defaults to instanceVar</dd><dd><code>useWriteMethods</code> - when true, set properties by public write + methods instead of protected fields - should be used if class being + generated doesn't have access to these fields</dd><dd><code>generation</code> - when non-negative, decoder expects a storable layout + generation value to match this value. Otherwise, it throws a + CorruptEncodingException.</dd><dd><code>altGenerationHandler</code> - if non-null and a generation is provided, + this label defines an alternate generation handler. It is executed + instead of throwing a CorruptEncodingException if the generation doesn't + match. The actual generation is available on the top of the stack for + the handler to consume.</dd><dd><code>encodedVar</code> - required variable, which must be a byte array. At + runtime, it references encoded data.</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 any property type is not supported</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if assembler is null, or if instanceVar + is not the correct instance type, or if encodedVar is not a byte array</dd></dl> +</li> +</ul> +<a name="buildSerialEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildSerialEncoding</h4> +<pre>public org.cojen.classfile.LocalVariable buildSerialEncoding(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates bytecode instructions to encode properties and their + states. This encoding is suitable for short-term serialization only.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>assembler</code> - code assembler to receive bytecode instructions</dd><dd><code>properties</code> - specific properties to decode, defaults to all + properties if null</dd> +<dt><span class="strong">Returns:</span></dt><dd>local variable referencing a byte array with encoded data</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 any property type is not supported</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="buildSerialDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildSerialDecoding</h4> +<pre>public void buildSerialDecoding(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable encodedVar) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates bytecode instructions to decode properties and their states. A + CorruptEncodingException may be thrown from generated code.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>assembler</code> - code assembler to receive bytecode instructions</dd><dd><code>properties</code> - specific properties to decode, defaults to all + properties if null</dd><dd><code>encodedVar</code> - required variable, which must be a byte array. At + runtime, it references encoded data.</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 any property type is not supported</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if encodedVar is not a byte array</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public final java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> getType()</pre> +<div class="block">Returns the type of Storable that code is generated for.</div> +</li> +</ul> +<a name="isSupported(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSupported</h4> +<pre>public boolean isSupported(java.lang.Class<?> propertyType)</pre> +<div class="block">Returns true if the type of the given property type is supported. The + types currently supported are primitives, primitive wrapper objects, + Strings, and byte arrays.</div> +</li> +</ul> +<a name="isSupported(org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSupported</h4> +<pre>public boolean isSupported(org.cojen.classfile.TypeDesc propertyType)</pre> +<div class="block">Returns true if the type of the given property type is supported. The + types currently supported are primitives, primitive wrapper objects, + Strings, byte arrays and Lobs.</div> +</li> +</ul> +<a name="getKeyPrefixPadding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeyPrefixPadding</h4> +<pre>public int getKeyPrefixPadding()</pre> +</li> +</ul> +<a name="getKeySuffixPadding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeySuffixPadding</h4> +<pre>public int getKeySuffixPadding()</pre> +</li> +</ul> +<a name="getDataPrefixPadding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataPrefixPadding</h4> +<pre>public int getDataPrefixPadding()</pre> +</li> +</ul> +<a name="getDataSuffixPadding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataSuffixPadding</h4> +<pre>public int getDataSuffixPadding()</pre> +</li> +</ul> +<a name="getConstantKeyPrefixLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstantKeyPrefixLength</h4> +<pre>public int getConstantKeyPrefixLength()</pre> +<div class="block">Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same. Default implementation returns 0.</div> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="getPrimaryKeyIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyIndex</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> getPrimaryKeyIndex()</pre> +<div class="block">Returns all key properties in the form of an index.</div> +</li> +</ul> +<a name="gatherAllKeyProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>gatherAllKeyProperties</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] gatherAllKeyProperties()</pre> +<div class="block">Returns all key properties as ordered properties, possibly with + unspecified directions.</div> +</li> +</ul> +<a name="gatherAllDataProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>gatherAllDataProperties</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] gatherAllDataProperties()</pre> +<div class="block">Returns all non-derived data properties for storable.</div> +</li> +</ul> +<a name="gatherAllProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>gatherAllProperties</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] gatherAllProperties()</pre> +<div class="block">Returns all non-join, non-derived properties for storable.</div> +</li> +</ul> +<a name="checkSupport(com.amazon.carbonado.info.StorableProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkSupport</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> checkSupport(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> property) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><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></dd></dl> +</li> +</ul> +<a name="checkSupport(com.amazon.carbonado.info.StorableProperty[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkSupport</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a>[] checkSupport(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><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></dd></dl> +</li> +</ul> +<a name="extraDataEncoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>extraDataEncoding</h4> +<pre>protected void extraDataEncoding(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix)</pre> +<div class="block">Second phase encoding, which does nothing by default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dataVar</code> - local variable referencing a byte array with data</dd><dd><code>prefix</code> - prefix of byte array to preserve</dd><dd><code>suffix</code> - suffix of byte array to preserve</dd></dl> +</li> +</ul> +<a name="extraDataDecoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>extraDataDecoding</h4> +<pre>protected void extraDataDecoding(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable dataVar, + int prefix, + int suffix)</pre> +<div class="block">Second phase decoding, which does nothing by default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dataVar</code> - local variable referencing a byte array with data</dd></dl> +</li> +</ul> +<a name="loadPropertyValue(org.cojen.classfile.LocalVariable[], java.lang.Boolean[], org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadPropertyValue</h4> +<pre>protected boolean loadPropertyValue(org.cojen.classfile.LocalVariable[] stashedProperties, + java.lang.Boolean[] stashedFromInstances, + org.cojen.classfile.CodeAssembler a, + <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar)</pre> +<div class="block">Generates code to load a property value onto the operand stack.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - info for property to load</dd><dd><code>ordinal</code> - zero-based property ordinal, used only if instanceVar + refers to an object array.</dd><dd><code>useReadMethod</code> - when true, access property by public read method + instead of protected field</dd><dd><code>instanceVar</code> - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.</dd><dd><code>adapterInstanceClass</code> - class containing static references to + adapter instances - defaults to instanceVar</dd><dd><code>partialStartVar</code> - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if property was loaded from instance, false if loaded from + value array</dd></dl> +</li> +</ul> +<a name="loadPropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadPropertyValue</h4> +<pre>protected boolean loadPropertyValue(org.cojen.classfile.CodeAssembler a, + <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar)</pre> +<div class="block">Generates code to load a property value onto the operand stack.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - info for property to load</dd><dd><code>ordinal</code> - zero-based property ordinal, used only if instanceVar + refers to an object array.</dd><dd><code>useReadMethod</code> - when true, access property by public read method + instead of protected field</dd><dd><code>instanceVar</code> - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are read from the runtime value of this array instead + of a Storable instance.</dd><dd><code>adapterInstanceClass</code> - class containing static references to + adapter instances - defaults to instanceVar</dd><dd><code>partialStartVar</code> - optional variable for supporting partial key + generation. It must be an int, whose runtime value must be less than the + properties array length. It marks the range start of the partial + property range.</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if property was loaded from instance, false if loaded from + value array</dd></dl> +</li> +</ul> +<a name="pushRawSupport(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pushRawSupport</h4> +<pre>protected void pushRawSupport(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.LocalVariable instanceVar) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Generates code to push RawSupport instance to the stack. RawSupport is + available only in Storable instances. If instanceVar is an Object[], a + SupportException is thrown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instanceVar</code> - Storable instance or array of property values. Null + is storable instance of "this".</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></dd></dl> +</li> +</ul> +<a name="pushDecodingInstanceVar(org.cojen.classfile.CodeAssembler, int, org.cojen.classfile.LocalVariable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pushDecodingInstanceVar</h4> +<pre>protected void pushDecodingInstanceVar(org.cojen.classfile.CodeAssembler a, + int ordinal, + org.cojen.classfile.LocalVariable instanceVar)</pre> +<div class="block">Push decoding instanceVar to stack in preparation to calling + storePropertyValue.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ordinal</code> - zero-based property ordinal, used only if instanceVar + refers to an object array.</dd><dd><code>instanceVar</code> - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are written to the runtime value of this array instead + of a Storable instance.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#storePropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, boolean, org.cojen.classfile.LocalVariable, java.lang.Class)"><code>storePropertyValue</code></a></dd></dl> +</li> +</ul> +<a name="storePropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, boolean, org.cojen.classfile.LocalVariable, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>storePropertyValue</h4> +<pre>protected void storePropertyValue(org.cojen.classfile.CodeAssembler a, + <a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + boolean useWriteMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass)</pre> +<div class="block">Generates code to store a property value into an instance which is + already on the operand stack. If instance is an Object array, index into + array must also be on the operand stack.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - info for property to store to</dd><dd><code>useWriteMethod</code> - when true, set property by public write method + instead of protected field</dd><dd><code>instanceVar</code> - local variable referencing Storable instance, + defaults to "this" if null. If variable type is an Object array, then + property values are written to the runtime value of this array instead + of a Storable instance.</dd><dd><code>adapterInstanceClass</code> - class containing static references to + adapter instances - defaults to instanceVar</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#pushDecodingInstanceVar(org.cojen.classfile.CodeAssembler, int, org.cojen.classfile.LocalVariable)"><code>pushDecodingInstanceVar</code></a></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/GenericEncodingStrategy.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/DataEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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/GenericEncodingStrategy.html" target="_top">Frames</a></li> +<li><a href="GenericEncodingStrategy.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html b/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html new file mode 100644 index 0000000..c4a26ad --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericInstanceFactory.html @@ -0,0 +1,250 @@ +<!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>GenericInstanceFactory (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="GenericInstanceFactory (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/GenericInstanceFactory.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/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.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/GenericInstanceFactory.html" target="_top">Frames</a></li> +<li><a href="GenericInstanceFactory.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 GenericInstanceFactory" class="title">Interface GenericInstanceFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">GenericInstanceFactory</span></pre> +<div class="block">Can be used with <a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><code>QuickConstructorGenerator</code></a> + for instantiating generic storable instances.</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><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[])">instantiate</a></strong>(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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> support, + byte[] key, + byte[] value)</code> </td> +</tr> +</table> +</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="instantiate(com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</pre> +</li> +</ul> +<a name="instantiate(com.amazon.carbonado.raw.RawSupport, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><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="instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> instantiate(<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key, + byte[] value) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><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> +</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/GenericInstanceFactory.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/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.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/GenericInstanceFactory.html" target="_top">Frames</a></li> +<li><a href="GenericInstanceFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html b/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html new file mode 100644 index 0000000..7250771 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericPropertyInfo.html @@ -0,0 +1,324 @@ +<!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>GenericPropertyInfo (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="GenericPropertyInfo (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/GenericPropertyInfo.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/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericPropertyInfo.html" target="_top">Frames</a></li> +<li><a href="GenericPropertyInfo.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 GenericPropertyInfo" class="title">Interface GenericPropertyInfo</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">GenericPropertyInfo</span></pre> +<div class="block">Minimal information required by <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><code>GenericEncodingStrategy</code></a> to encode + and decode a storable property.</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>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter</a></strong>()</code> +<div class="block">Returns the optional method used to adapt the property from the + storage supported type to the user visible type.</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/raw/GenericPropertyInfo.html#getPropertyName()">getPropertyName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.cojen.classfile.TypeDesc</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyType()">getPropertyType</a></strong>()</code> +<div class="block">Returns the user specified property type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.TypeDesc</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getStorageType()">getStorageType</a></strong>()</code> +<div class="block">Returns the storage supported type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getToStorageAdapter()">getToStorageAdapter</a></strong>()</code> +<div class="block">Returns the optional method used to adapt the property from the user + visible type to the storage supported type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isDerived()">isDerived</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isLob()">isLob</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isNullable()">isNullable</a></strong>()</code> </td> +</tr> +</table> +</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="getPropertyName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyName</h4> +<pre>java.lang.String getPropertyName()</pre> +</li> +</ul> +<a name="getPropertyType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyType</h4> +<pre>org.cojen.classfile.TypeDesc getPropertyType()</pre> +<div class="block">Returns the user specified property type.</div> +</li> +</ul> +<a name="getStorageType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageType</h4> +<pre>org.cojen.classfile.TypeDesc getStorageType()</pre> +<div class="block">Returns the storage supported type. If it differs from the property + type, then adapter methods must also exist.</div> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>boolean isNullable()</pre> +</li> +</ul> +<a name="isLob()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLob</h4> +<pre>boolean isLob()</pre> +</li> +</ul> +<a name="isDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDerived</h4> +<pre>boolean isDerived()</pre> +</li> +</ul> +<a name="getFromStorageAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFromStorageAdapter</h4> +<pre>java.lang.reflect.Method getFromStorageAdapter()</pre> +<div class="block">Returns the optional method used to adapt the property from the + storage supported type to the user visible type.</div> +</li> +</ul> +<a name="getToStorageAdapter()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getToStorageAdapter</h4> +<pre>java.lang.reflect.Method getToStorageAdapter()</pre> +<div class="block">Returns the optional method used to adapt the property from the user + visible type to the storage supported type.</div> +</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/GenericPropertyInfo.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/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericPropertyInfo.html" target="_top">Frames</a></li> +<li><a href="GenericPropertyInfo.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> diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html new file mode 100644 index 0000000..b765c1f --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html @@ -0,0 +1,222 @@ +<!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>GenericStorableCodec.Decoder (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="GenericStorableCodec.Decoder (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/GenericStorableCodec.Decoder.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/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.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/GenericStorableCodec.Decoder.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.Decoder.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 GenericStorableCodec.Decoder" class="title">Interface GenericStorableCodec.Decoder<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>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">GenericStorableCodec.Decoder<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Used for decoding different generations of Storable.</div> +</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/GenericStorableCodec.Decoder.html#decode(S, byte[])">decode</a></strong>(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="type parameter in GenericStorableCodec.Decoder">S</a> dest, + byte[] data)</code> </td> +</tr> +</table> +</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="decode(com.amazon.carbonado.Storable,byte[])"> +<!-- --> +</a><a name="decode(S, byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decode</h4> +<pre>void decode(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="type parameter in GenericStorableCodec.Decoder">S</a> dest, + byte[] data) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dest</code> - storable to receive decoded properties</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></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/GenericStorableCodec.Decoder.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/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.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/GenericStorableCodec.Decoder.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.Decoder.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> diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html new file mode 100644 index 0000000..9201b11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html @@ -0,0 +1,313 @@ +<!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>GenericStorableCodec.SearchKeyFactory (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="GenericStorableCodec.SearchKeyFactory (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/GenericStorableCodec.SearchKeyFactory.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/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.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/GenericStorableCodec.SearchKeyFactory.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.SearchKeyFactory.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 GenericStorableCodec.SearchKeyFactory" class="title">Interface GenericStorableCodec.SearchKeyFactory<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>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">GenericStorableCodec.SearchKeyFactory<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Creates custom raw search keys for <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types. It is + intended for supporting queries and indexes.</div> +</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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKey(java.lang.Object[])">encodeSearchKey</a></strong>(java.lang.Object[] values)</code> +<div class="block">Build a search key by supplying property values without a 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/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKey(java.lang.Object[], int, int)">encodeSearchKey</a></strong>(java.lang.Object[] values, + int rangeStart, + int rangeEnd)</code> +<div class="block">Build a search key by supplying property values without a storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKey(S)">encodeSearchKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="type parameter in GenericStorableCodec.SearchKeyFactory">S</a> storable)</code> +<div class="block">Build a search key by extracting all the desired 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/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKey(S, int, int)">encodeSearchKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="type parameter in GenericStorableCodec.SearchKeyFactory">S</a> storable, + int rangeStart, + int rangeEnd)</code> +<div class="block">Build a search key by extracting all the desired properties from the + given storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKeyPrefix()">encodeSearchKeyPrefix</a></strong>()</code> +<div class="block">Returns the search key for when there are no values.</div> +</td> +</tr> +</table> +</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="encodeSearchKey(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="encodeSearchKey(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSearchKey</h4> +<pre>byte[] encodeSearchKey(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="type parameter in GenericStorableCodec.SearchKeyFactory">S</a> storable)</pre> +<div class="block">Build a search key by extracting all the desired properties from the + given storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - extract a subset of properties from this instance</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodeSearchKey(com.amazon.carbonado.Storable,int,int)"> +<!-- --> +</a><a name="encodeSearchKey(S, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSearchKey</h4> +<pre>byte[] encodeSearchKey(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="type parameter in GenericStorableCodec.SearchKeyFactory">S</a> storable, + int rangeStart, + int rangeEnd)</pre> +<div class="block">Build a search key by extracting all the desired properties from the + given storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - extract a subset of properties from this instance</dd><dd><code>rangeStart</code> - index of first property to use. Its value must be less + than the count of properties used by this factory.</dd><dd><code>rangeEnd</code> - index of last property to use, exlusive. Its value must + be less than or equal to the count of properties used by this factory.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodeSearchKey(java.lang.Object[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSearchKey</h4> +<pre>byte[] encodeSearchKey(java.lang.Object[] values)</pre> +<div class="block">Build a search key by supplying property values without a storable.</div> +<dl><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 of properties used by this factory.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodeSearchKey(java.lang.Object[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSearchKey</h4> +<pre>byte[] encodeSearchKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd)</pre> +<div class="block">Build a search key by supplying property values without a storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - values to build into a key. The length may be less than + the amount of properties used by this factory. It must not be less than the + difference between rangeStart and rangeEnd.</dd><dd><code>rangeStart</code> - index of first property to use. Its value must be less + than the count of properties used by this factory.</dd><dd><code>rangeEnd</code> - index of last property to use, exlusive. Its value must + be less than or equal to the count of properties used by this factory.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodeSearchKeyPrefix()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>encodeSearchKeyPrefix</h4> +<pre>byte[] encodeSearchKeyPrefix()</pre> +<div class="block">Returns the search key for when there are no values. Returned value + may be null.</div> +</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/GenericStorableCodec.SearchKeyFactory.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/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.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/GenericStorableCodec.SearchKeyFactory.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.SearchKeyFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html new file mode 100644 index 0000000..77cb1f3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodec.html @@ -0,0 +1,702 @@ +<!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>GenericStorableCodec (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="GenericStorableCodec (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/GenericStorableCodec.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/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.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/GenericStorableCodec.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.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>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="Class GenericStorableCodec" class="title">Class GenericStorableCodec<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.GenericStorableCodec<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 class <span class="strong">GenericStorableCodec<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">Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.</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/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><code>GenericStorableCodecFactory</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/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="type parameter in GenericStorableCodec.Decoder">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Used for decoding different generations of Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="type parameter in GenericStorableCodec.SearchKeyFactory">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Creates custom raw search keys for <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types.</div> +</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#decode(S, int, byte[])">decode</a></strong>(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#encodePrimaryKey(java.lang.Object[], int, int)">encodePrimaryKey</a></strong>(java.lang.Object[] values, + int rangeStart, + int rangeEnd)</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/GenericStorableCodec.html#encodePrimaryKey(S)">encodePrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#encodePrimaryKey(S, int, int)">encodePrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> storable, + int rangeStart, + int rangeEnd)</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/GenericStorableCodec.html#encodePrimaryKeyPrefix()">encodePrimaryKeyPrefix</a></strong>()</code> +<div class="block">Encode the primary key for when there are no values, but there may be a + prefix.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getDecoder(int)">getDecoder</a></strong>(int generation)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use direct decode method</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength</a></strong>()</code> +<div class="block">Returns the number of prefix bytes in the primary key, which may be + zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getSearchKeyFactory(com.amazon.carbonado.info.OrderedProperty[])">getSearchKeyFactory</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>>[] properties)</code> +<div class="block">Returns a search key factory, which is useful for implementing indexes + and queries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getStorableClass()">getStorableClass</a></strong>()</code> +<div class="block">Returns a concrete Storable implementation, which is fully + thread-safe.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the type of Storable that code is generated for.</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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(byte[])">instantiate</a></strong>(byte[] key)</code> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> support)</code> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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> +</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>public final java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> getStorableType()</pre> +<div class="block">Returns the type of Storable that code is generated for.</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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> instantiate()</pre> +<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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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>java.lang.IllegalStateException</code> - if no default support exists</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="instantiate(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> instantiate(byte[] key) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Instantiate a Storable with no 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(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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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>java.lang.IllegalStateException</code> - if no default support exists</dd> +<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(byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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>java.lang.IllegalStateException</code> - if no default support exists</dd> +<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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> support)</pre> +<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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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="getPrimaryKeyIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyIndex</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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> getPrimaryKeyIndex()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">StorableCodec</a></code></strong></div> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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="getPrimaryKeyPrefixLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyPrefixLength</h4> +<pre>public int getPrimaryKeyPrefixLength()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyPrefixLength()">StorableCodec</a></code></strong></div> +<div class="block">Returns the number of prefix bytes in the primary key, which may be + zero.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength</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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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="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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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(com.amazon.carbonado.Storable,int,int)"> +<!-- --> +</a><a name="encodePrimaryKey(S, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>public byte[] encodePrimaryKey(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> storable, + int rangeStart, + int rangeEnd)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S, int, int)">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, int, int)">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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><dd><code>rangeStart</code> - index of first property to use. Its value must be less + than the count of primary key properties.</dd><dd><code>rangeEnd</code> - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.</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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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="encodePrimaryKey(java.lang.Object[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>public byte[] encodePrimaryKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[], int, int)">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[], int, int)">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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. The length may be less than + the amount of primary key properties used by this factory. It must not + be less than the difference between rangeStart and rangeEnd.</dd><dd><code>rangeStart</code> - index of first property to use. Its value must be less + than the count of primary key properties.</dd><dd><code>rangeEnd</code> - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodePrimaryKeyPrefix()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKeyPrefix</h4> +<pre>public byte[] encodePrimaryKeyPrefix()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKeyPrefix()">StorableCodec</a></code></strong></div> +<div class="block">Encode the primary key for when there are no values, but there may be a + prefix. Returned value may be null if no prefix is defined.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKeyPrefix()">encodePrimaryKeyPrefix</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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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="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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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="getStorableClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> getStorableClass()</pre> +<div class="block">Returns a concrete Storable implementation, which is fully + thread-safe. It has two constructors defined: + + <pre> + public <init>(Storage, RawSupport); + + public <init>(Storage, RawSupport, byte[] key, byte[] value); + </pre> + + Convenience methods are provided in this class to instantiate the + generated Storable.</div> +</li> +</ul> +<a name="getSearchKeyFactory(com.amazon.carbonado.info.OrderedProperty[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSearchKeyFactory</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> getSearchKeyFactory(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>>[] properties)</pre> +<div class="block">Returns a search key factory, which is useful for implementing indexes + and queries.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - properties to build the search key from</dd></dl> +</li> +</ul> +<a name="decode(com.amazon.carbonado.Storable,int,byte[])"> +<!-- --> +</a><a name="decode(S, int, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public void decode(<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#decode(S, int, byte[])">StorableCodec</a></code></strong></div> +<div class="block">Used for decoding different generations of Storable. If layout + generations are not supported, simply throw a CorruptEncodingException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#decode(S, int, byte[])">decode</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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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>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></dl> +</li> +</ul> +<a name="getDecoder(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDecoder</h4> +<pre>@Deprecated +public <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a><<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> getDecoder(int generation) + throws <a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a>, + <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> <i>use direct decode method</i></div> +<div class="block">Returns a data decoder for the given generation.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></code> - if generation is unknown</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</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/GenericStorableCodec.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/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.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/GenericStorableCodec.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.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>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> diff --git a/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html new file mode 100644 index 0000000..4e2076c --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GenericStorableCodecFactory.html @@ -0,0 +1,406 @@ +<!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>GenericStorableCodecFactory (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="GenericStorableCodecFactory (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/GenericStorableCodecFactory.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/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GzipCompressor.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/GenericStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodecFactory.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><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 GenericStorableCodecFactory" class="title">Class GenericStorableCodecFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.GenericStorableCodecFactory</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/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">GenericStorableCodecFactory</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></pre> +<div class="block">Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.</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"> +<!-- ======== 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/GenericStorableCodecFactory.html#GenericStorableCodecFactory()">GenericStorableCodecFactory</a></strong>()</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><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null.</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/raw/GenericStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns null to let repository decide what the name should be.</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> +</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="GenericStorableCodecFactory()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GenericStorableCodecFactory</h4> +<pre>public GenericStorableCodecFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorageName(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageName</h4> +<pre>public java.lang.String getStorageName(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Returns null to let repository decide what the name should be.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></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 type is not supported</dd></dl> +</li> +</ul> +<a name="getLayoutOptions(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLayoutOptions</h4> +<pre>public <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> getLayoutOptions(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<div class="block">Returns null.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></dd> +</dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createCodec</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S> createCodec(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to create codec for</dd><dd><code>pkIndex</code> - suggested index for primary key (optional)</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, encode a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.</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 type is not supported</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createCodec</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S> createCodec(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable to create codec for</dd><dd><code>pkIndex</code> - suggested index for primary key (optional)</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, encode a storable layout generation + value in one or four bytes. Generation 0..127 is encoded in one byte, and + 128..max is encoded in four bytes, with the most significant bit set.</dd><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/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if type is not supported</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStrategy</h4> +<pre>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S> createStrategy(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Override to return a different EncodingStrategy.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable to generate code for</dd><dd><code>pkIndex</code> - specifies sequence and ordering of key properties (optional)</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></dd></dl> +</li> +</ul> +<a name="createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createStrategy</h4> +<pre>protected <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S> createStrategy(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Override to return a different EncodingStrategy.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable to generate code for</dd><dd><code>pkIndex</code> - specifies sequence and ordering of key properties (optional)</dd><dd><code>options</code> - additional layout options (optional)</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></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/GenericStorableCodecFactory.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/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/GzipCompressor.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/GenericStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodecFactory.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/GzipCompressor.html b/apidocs/com/amazon/carbonado/raw/GzipCompressor.html new file mode 100644 index 0000000..c00b111 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GzipCompressor.html @@ -0,0 +1,294 @@ +<!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>GzipCompressor (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="GzipCompressor (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/GzipCompressor.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/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.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/GzipCompressor.html" target="_top">Frames</a></li> +<li><a href="GzipCompressor.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><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 GzipCompressor" class="title">Class GzipCompressor</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.GzipCompressor</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">GzipCompressor</span> +extends java.lang.Object</pre> +<div class="block">Raw-level data compression using gzip.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Olga Kuznetsova, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/GzipCompressor.html#GzipCompressor()">GzipCompressor</a></strong>()</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>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GzipCompressor.html#compress(byte[], int)">compress</a></strong>(byte[] value, + int prefix)</code> +<div class="block">Encodes into compressed form.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/GzipCompressor.html#decompress(byte[], int)">decompress</a></strong>(byte[] value, + int prefix)</code> +<div class="block">Decodes from compressed form.</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> +</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="GzipCompressor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GzipCompressor</h4> +<pre>public GzipCompressor()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="compress(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compress</h4> +<pre>public static byte[] compress(byte[] value, + int prefix) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Encodes into compressed form.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - value to compress</dd><dd><code>prefix</code> - prefix of byte array to preserve</dd> +<dt><span class="strong">Returns:</span></dt><dd>compressed value</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> - thrown if compression failed</dd></dl> +</li> +</ul> +<a name="decompress(byte[], int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decompress</h4> +<pre>public static byte[] decompress(byte[] value, + int prefix) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes from compressed form.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - value to decompress</dd><dd><code>prefix</code> - prefix of byte array to preserve</dd> +<dt><span class="strong">Returns:</span></dt><dd>decompressed value</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> - thrown if value cannot be decompressed</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/GzipCompressor.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/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.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/GzipCompressor.html" target="_top">Frames</a></li> +<li><a href="GzipCompressor.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/KeyDecoder.html b/apidocs/com/amazon/carbonado/raw/KeyDecoder.html new file mode 100644 index 0000000..d46933a --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/KeyDecoder.html @@ -0,0 +1,936 @@ +<!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>KeyDecoder (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="KeyDecoder (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/KeyDecoder.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/GzipCompressor.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.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/KeyDecoder.html" target="_top">Frames</a></li> +<li><a href="KeyDecoder.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><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 KeyDecoder" class="title">Class KeyDecoder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.KeyDecoder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">KeyDecoder</span> +extends java.lang.Object</pre> +<div class="block">A very low-level class that decodes key components encoded by methods of + <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><code>KeyEncoder</code></a>.</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/DataDecoder.html" title="class in com.amazon.carbonado.raw"><code>DataDecoder</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/KeyDecoder.html#KeyDecoder()">KeyDecoder</a></strong>()</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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, java.math.BigDecimal[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef)</code> +<div class="block">Decodes the given BigDecimal as originally encoded for ascending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, java.math.BigInteger[])">decode</a></strong>(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef)</code> +<div class="block">Decodes the given BigInteger as originally encoded for ascending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, byte[][])">decode</a></strong>(byte[] src, + int srcOffset, + byte[][] valueRef)</code> +<div class="block">Decodes the given byte array as originally encoded for ascending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeBooleanDesc(byte[], int)">decodeBooleanDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a boolean from exactly 1 byte, as encoded for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeBooleanObjDesc(byte[], int)">decodeBooleanObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeByteDesc(byte[], int)">decodeByteDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed byte from exactly 1 byte, as encoded for descending + order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Byte</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeByteObjDesc(byte[], int)">decodeByteObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Character</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeCharacterObjDesc(byte[], int)">decodeCharacterObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeCharDesc(byte[], int)">decodeCharDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a char from exactly 2 bytes, as encoded for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, java.math.BigDecimal[])">decodeDesc</a></strong>(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef)</code> +<div class="block">Decodes the given BigDecimal as originally encoded for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, java.math.BigInteger[])">decodeDesc</a></strong>(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef)</code> +<div class="block">Decodes the given BigInteger as originally encoded for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, byte[][])">decodeDesc</a></strong>(byte[] src, + int srcOffset, + byte[][] valueRef)</code> +<div class="block">Decodes the given byte array as originally encoded for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static double</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDoubleDesc(byte[], int)">decodeDoubleDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a double from exactly 8 bytes, as encoded for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Double</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeDoubleObjDesc(byte[], int)">decodeDoubleObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeFloatDesc(byte[], int)">decodeFloatDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a float from exactly 4 bytes, as encoded for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Float</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeFloatObjDesc(byte[], int)">decodeFloatObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeIntDesc(byte[], int)">decodeIntDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeIntegerObjDesc(byte[], int)">decodeIntegerObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeLongDesc(byte[], int)">decodeLongDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed long from exactly 8 bytes, as encoded for descending + order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeLongObjDesc(byte[], int)">decodeLongObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static short</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeShortDesc(byte[], int)">decodeShortDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed short from exactly 2 bytes, as encoded for descending + order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Short</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeShortObjDesc(byte[], int)">decodeShortObjDesc</a></strong>(byte[] src, + int srcOffset)</code> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleDesc(byte[])">decodeSingleDesc</a></strong>(byte[] src)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])"><code>KeyEncoder.encodeSingleDesc(byte[])</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleDesc(byte[], int, int)">decodeSingleDesc</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])"><code>KeyEncoder.encodeSingleDesc(byte[])</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleNullableDesc(byte[])">decodeSingleNullableDesc</a></strong>(byte[] src)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])"><code>KeyEncoder.encodeSingleNullableDesc(byte[])</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleNullableDesc(byte[], int, int)">decodeSingleNullableDesc</a></strong>(byte[] src, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])"><code>KeyEncoder.encodeSingleNullableDesc(byte[])</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeString(byte[], int, java.lang.String[])">decodeString</a></strong>(byte[] src, + int srcOffset, + java.lang.String[] valueRef)</code> +<div class="block">Decodes an encoded string from the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html#decodeStringDesc(byte[], int, java.lang.String[])">decodeStringDesc</a></strong>(byte[] src, + int srcOffset, + java.lang.String[] valueRef)</code> +<div class="block">Decodes an encoded string from the given byte array as originally + encoded for descending order.</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> +</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="KeyDecoder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KeyDecoder</h4> +<pre>public KeyDecoder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="decodeIntDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeIntDesc</h4> +<pre>public static int decodeIntDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed integer value</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></dd></dl> +</li> +</ul> +<a name="decodeIntegerObjDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeIntegerObjDesc</h4> +<pre>public static java.lang.Integer decodeIntegerObjDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order. If null is returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Integer object or null</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></dd></dl> +</li> +</ul> +<a name="decodeLongDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeLongDesc</h4> +<pre>public static long decodeLongDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed long from exactly 8 bytes, as encoded for descending + order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed long value</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></dd></dl> +</li> +</ul> +<a name="decodeLongObjDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeLongObjDesc</h4> +<pre>public static java.lang.Long decodeLongObjDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Long object or null</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></dd></dl> +</li> +</ul> +<a name="decodeByteDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeByteDesc</h4> +<pre>public static byte decodeByteDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed byte from exactly 1 byte, as encoded for descending + order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed byte value</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></dd></dl> +</li> +</ul> +<a name="decodeByteObjDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeByteObjDesc</h4> +<pre>public static java.lang.Byte decodeByteObjDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Byte object or null</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></dd></dl> +</li> +</ul> +<a name="decodeShortDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeShortDesc</h4> +<pre>public static short decodeShortDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed short from exactly 2 bytes, as encoded for descending + order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed short value</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></dd></dl> +</li> +</ul> +<a name="decodeShortObjDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeShortObjDesc</h4> +<pre>public static java.lang.Short decodeShortObjDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>signed Short object or null</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></dd></dl> +</li> +</ul> +<a name="decodeCharDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeCharDesc</h4> +<pre>public static char decodeCharDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a char from exactly 2 bytes, as encoded for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>char value</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></dd></dl> +</li> +</ul> +<a name="decodeCharacterObjDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeCharacterObjDesc</h4> +<pre>public static java.lang.Character decodeCharacterObjDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order. If null is returned, then 1 byte was read.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Character object or null</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></dd></dl> +</li> +</ul> +<a name="decodeBooleanDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeBooleanDesc</h4> +<pre>public static boolean decodeBooleanDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a boolean from exactly 1 byte, as encoded for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>boolean value</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></dd></dl> +</li> +</ul> +<a name="decodeBooleanObjDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeBooleanObjDesc</h4> +<pre>public static java.lang.Boolean decodeBooleanObjDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Boolean object or null</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></dd></dl> +</li> +</ul> +<a name="decodeFloatDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeFloatDesc</h4> +<pre>public static float decodeFloatDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a float from exactly 4 bytes, as encoded for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>float value</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></dd></dl> +</li> +</ul> +<a name="decodeFloatObjDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeFloatObjDesc</h4> +<pre>public static java.lang.Float decodeFloatObjDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Float object or null</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></dd></dl> +</li> +</ul> +<a name="decodeDoubleDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDoubleDesc</h4> +<pre>public static double decodeDoubleDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a double from exactly 8 bytes, as encoded for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>double value</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></dd></dl> +</li> +</ul> +<a name="decodeDoubleObjDesc(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDoubleObjDesc</h4> +<pre>public static java.lang.Double decodeDoubleObjDesc(byte[] src, + int srcOffset) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded bytes</dd><dd><code>srcOffset</code> - offset into source array</dd> +<dt><span class="strong">Returns:</span></dt><dd>Double object or null</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></dd></dl> +</li> +</ul> +<a name="decode(byte[], int, java.math.BigInteger[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given BigInteger as originally encoded for ascending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded BigInteger is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decodeDesc(byte[], int, java.math.BigInteger[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDesc</h4> +<pre>public static int decodeDesc(byte[] src, + int srcOffset, + java.math.BigInteger[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given BigInteger as originally encoded for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded BigInteger is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decode(byte[], int, java.math.BigDecimal[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given BigDecimal as originally encoded for ascending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded BigDecimal is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decodeDesc(byte[], int, java.math.BigDecimal[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDesc</h4> +<pre>public static int decodeDesc(byte[] src, + int srcOffset, + java.math.BigDecimal[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given BigDecimal as originally encoded for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded BigDecimal is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="decode(byte[], int, byte[][])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>public static int decode(byte[] src, + int srcOffset, + byte[][] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array as originally encoded for ascending order. + The decoding stops when any kind of terminator or illegal byte has been + read. The decoded bytes are stored in valueRef.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded byte array is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd></dl> +</li> +</ul> +<a name="decodeDesc(byte[], int, byte[][])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeDesc</h4> +<pre>public static int decodeDesc(byte[] src, + int srcOffset, + byte[][] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array as originally encoded for descending order. + The decoding stops when any kind of terminator or illegal byte has been + read. The decoded bytes are stored in valueRef.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded byte array is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd></dl> +</li> +</ul> +<a name="decodeString(byte[], int, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeString</h4> +<pre>public static int decodeString(byte[] src, + int srcOffset, + java.lang.String[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes an encoded string from the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded string is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd></dl> +</li> +</ul> +<a name="decodeStringDesc(byte[], int, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeStringDesc</h4> +<pre>public static int decodeStringDesc(byte[] src, + int srcOffset, + java.lang.String[] valueRef) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes an encoded string from the given byte array as originally + encoded for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - source of encoded data</dd><dd><code>srcOffset</code> - offset into encoded data</dd><dd><code>valueRef</code> - decoded string is stored in element 0, which may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes read from source</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 source data is corrupt</dd></dl> +</li> +</ul> +<a name="decodeSingleDesc(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeSingleDesc</h4> +<pre>public static byte[] decodeSingleDesc(byte[] src) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])"><code>KeyEncoder.encodeSingleDesc(byte[])</code></a>. Always returns a new byte array instance.</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="decodeSingleDesc(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeSingleDesc</h4> +<pre>public static byte[] decodeSingleDesc(byte[] src, + int prefixPadding, + int suffixPadding) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])"><code>KeyEncoder.encodeSingleDesc(byte[])</code></a>. Always returns a new byte array instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to skip from start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to skip at end of encoded byte array</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></dd></dl> +</li> +</ul> +<a name="decodeSingleNullableDesc(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decodeSingleNullableDesc</h4> +<pre>public static byte[] decodeSingleNullableDesc(byte[] src) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])"><code>KeyEncoder.encodeSingleNullableDesc(byte[])</code></a>. Always returns a new byte array + instance.</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="decodeSingleNullableDesc(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decodeSingleNullableDesc</h4> +<pre>public static byte[] decodeSingleNullableDesc(byte[] src, + int prefixPadding, + int suffixPadding) + throws <a href="../../../../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></pre> +<div class="block">Decodes the given byte array which was encoded by <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])"><code>KeyEncoder.encodeSingleNullableDesc(byte[])</code></a>. Always returns a new byte array + instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to skip from start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to skip at end of encoded byte array</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></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/KeyDecoder.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/GzipCompressor.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.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/KeyDecoder.html" target="_top">Frames</a></li> +<li><a href="KeyDecoder.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/KeyEncoder.html b/apidocs/com/amazon/carbonado/raw/KeyEncoder.html new file mode 100644 index 0000000..12b1a29 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/KeyEncoder.html @@ -0,0 +1,1086 @@ +<!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>KeyEncoder (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="KeyEncoder (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/KeyEncoder.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/KeyDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/RawCursor.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/KeyEncoder.html" target="_top">Frames</a></li> +<li><a href="KeyEncoder.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><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 KeyEncoder" class="title">Class KeyEncoder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.KeyEncoder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">KeyEncoder</span> +extends java.lang.Object</pre> +<div class="block">A very low-level class that supports encoding of primitive data into unique, + sortable byte array keys. If the data to encode is of a variable size, then + it is written in base-32768, using only byte values 32..223. This allows + special values such as nulls and terminators to be unambiguously + encoded. Terminators for variable data can be encoded using 1 for ascending + order and 254 for descending order. Nulls can be encoded as 255 for high + ordering and 0 for low ordering.</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/KeyDecoder.html" title="class in com.amazon.carbonado.raw"><code>KeyDecoder</code></a>, +<a href="../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw"><code>DataEncoder</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/KeyEncoder.html#KeyEncoder()">KeyEncoder</a></strong>()</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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedLength(java.math.BigDecimal)">calculateEncodedLength</a></strong>(java.math.BigDecimal value)</code> +<div class="block">Returns the amount of bytes required to encode a BigDecimal.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedLength(java.math.BigInteger)">calculateEncodedLength</a></strong>(java.math.BigInteger value)</code> +<div class="block">Returns the amount of bytes required to encode a BigInteger.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedLength(byte[])">calculateEncodedLength</a></strong>(byte[] value)</code> +<div class="block">Returns the amount of bytes required to encode a byte array of the given + length.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedLength(byte[], int, int)">calculateEncodedLength</a></strong>(byte[] value, + int valueOffset, + int valueLength)</code> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedStringLength(java.lang.String)">calculateEncodedStringLength</a></strong>(java.lang.String value)</code> +<div class="block">Returns the amount of bytes required to encode the given String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encode(java.math.BigDecimal, byte[], int)">encode</a></strong>(java.math.BigDecimal value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional BigDecimal into a variable amount of + bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encode(java.math.BigInteger, byte[], int)">encode</a></strong>(java.math.BigInteger value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional BigInteger into a variable amount of + bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encode(byte[], byte[], int)">encode</a></strong>(byte[] value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encode(byte[], int, int, byte[], int)">encode</a></strong>(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encode(java.lang.String, byte[], int)">encode</a></strong>(java.lang.String value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional String into a variable amount of bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.math.BigDecimal, byte[], int)">encodeDesc</a></strong>(java.math.BigDecimal value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional BigDecimal into a variable amount of bytes + for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.math.BigInteger, byte[], int)">encodeDesc</a></strong>(java.math.BigInteger value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional BigInteger into a variable amount of bytes + for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(boolean, byte[], int)">encodeDesc</a></strong>(boolean value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given boolean into exactly 1 byte for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Boolean, byte[], int)">encodeDesc</a></strong>(java.lang.Boolean value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Boolean object into exactly 1 byte for descending + order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(byte[], byte[], int)">encodeDesc</a></strong>(byte[] value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(byte[], int, int, byte[], int)">encodeDesc</a></strong>(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(byte, byte[], int)">encodeDesc</a></strong>(byte value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed byte into exactly 1 byte for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Byte, byte[], int)">encodeDesc</a></strong>(java.lang.Byte value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Character, byte[], int)">encodeDesc</a></strong>(java.lang.Character value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Character object into exactly 1 or 3 bytes for + descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(char, byte[], int)">encodeDesc</a></strong>(char value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given character into exactly 2 bytes for descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(double, byte[], int)">encodeDesc</a></strong>(double value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given double into exactly 8 bytes for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Double, byte[], int)">encodeDesc</a></strong>(java.lang.Double value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Double object into exactly 8 bytes for descending + order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(float, byte[], int)">encodeDesc</a></strong>(float value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given float into exactly 4 bytes for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Float, byte[], int)">encodeDesc</a></strong>(java.lang.Float value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given Float object into exactly 4 bytes for descending + order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(int, byte[], int)">encodeDesc</a></strong>(int value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed integer into exactly 4 bytes for descending + order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Integer, byte[], int)">encodeDesc</a></strong>(java.lang.Integer value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(long, byte[], int)">encodeDesc</a></strong>(long value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed long into exactly 8 bytes for descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Long, byte[], int)">encodeDesc</a></strong>(java.lang.Long value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(short, byte[], int)">encodeDesc</a></strong>(short value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed short into exactly 2 bytes for descending + order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Short, byte[], int)">encodeDesc</a></strong>(java.lang.Short value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes for + descending order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.String, byte[], int)">encodeDesc</a></strong>(java.lang.String value, + byte[] dst, + int dstOffset)</code> +<div class="block">Encodes the given optional String into a variable amount of bytes for + descending order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])">encodeSingleDesc</a></strong>(byte[] value)</code> +<div class="block">Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[], int, int)">encodeSingleDesc</a></strong>(byte[] value, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])">encodeSingleNullableDesc</a></strong>(byte[] value)</code> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[], int, int)">encodeSingleNullableDesc</a></strong>(byte[] value, + int prefixPadding, + int suffixPadding)</code> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.</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> +</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="KeyEncoder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KeyEncoder</h4> +<pre>public KeyEncoder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="encodeDesc(int, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(int value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed integer into exactly 4 bytes for descending + order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed integer value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.Integer, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(java.lang.Integer value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes for + descending order. If the Integer object is never expected to be null, + consider encoding as an int primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Integer value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encodeDesc(long, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(long value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed long into exactly 8 bytes for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed long value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.Long, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(java.lang.Long value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes for + descending order. If the Long object is never expected to be null, + consider encoding as a long primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Long value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encodeDesc(byte, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(byte value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed byte into exactly 1 byte for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed byte value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.Byte, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(java.lang.Byte value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes for + descending order. If the Byte object is never expected to be null, + consider encoding as a byte primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Byte value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encodeDesc(short, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(short value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed short into exactly 2 bytes for descending + order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - signed short value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.Short, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(java.lang.Short value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes for + descending order. If the Short object is never expected to be null, + consider encoding as a short primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional signed Short value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encodeDesc(char, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(char value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given character into exactly 2 bytes for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - character value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.Character, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(java.lang.Character value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Character object into exactly 1 or 3 bytes for + descending order. If the Character object is never expected to be null, + consider encoding as a char primitive.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Character value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encodeDesc(boolean, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(boolean value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given boolean into exactly 1 byte for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - boolean value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.Boolean, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(java.lang.Boolean value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Boolean object into exactly 1 byte for descending + order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Boolean value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(float, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(float value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given float into exactly 4 bytes for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - float value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.Float, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(java.lang.Float value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Float object into exactly 4 bytes for descending + order. A non-canonical NaN value is used to represent null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Float value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(double, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(double value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given double into exactly 8 bytes for descending order.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - double value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.Double, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static void encodeDesc(java.lang.Double value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given Double object into exactly 8 bytes for descending + order. A non-canonical NaN value is used to represent null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - optional Double value to encode</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd></dl> +</li> +</ul> +<a name="encode(java.math.BigInteger, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.math.BigInteger value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional BigInteger into a variable amount of + bytes. If the BigInteger is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.math.BigInteger, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(java.math.BigInteger value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional BigInteger into a variable amount of bytes + for descending order. If the BigInteger is null, exactly 1 byte is + written. Otherwise, the amount written can be determined by calling + calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(java.math.BigInteger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(java.math.BigInteger value)</pre> +<div class="block">Returns the amount of bytes required to encode a BigInteger.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigInteger value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encode(java.math.BigDecimal, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.math.BigDecimal value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional BigDecimal into a variable amount of + bytes. If the BigDecimal is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength. + + <p><i>Note:</i> It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.math.BigDecimal, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(java.math.BigDecimal value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional BigDecimal into a variable amount of bytes + for descending order. If the BigDecimal is null, exactly 1 byte is + written. Otherwise, the amount written can be determined by calling + calculateEncodedLength. + + <p><i>Note:</i> It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(java.math.BigDecimal)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(java.math.BigDecimal value)</pre> +<div class="block">Returns the amount of bytes required to encode a BigDecimal. + + <p><i>Note:</i> It is recommended that value be normalized by stripping + trailing zeros. This makes searching by value much simpler.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - BigDecimal value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="encode(byte[], byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(byte[] value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encode(byte[], int, int, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes. If the byte array is null, exactly 1 byte is written. Otherwise, + the amount written can be determined by calling calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encodeDesc(byte[], byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(byte[] value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order. If the byte array is null, exactly 1 byte is + written. Otherwise, the amount written is determined by calling + calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encodeDesc(byte[], int, int, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(byte[] value, + int valueOffset, + int valueLength, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order. If the byte array is null, exactly 1 byte is + written. Otherwise, the amount written is determined by calling + calculateEncodedLength.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(byte[] value)</pre> +<div class="block">Returns the amount of bytes required to encode a byte array of the given + length.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd></dl> +</li> +</ul> +<a name="calculateEncodedLength(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedLength</h4> +<pre>public static int calculateEncodedLength(byte[] value, + int valueOffset, + int valueLength)</pre> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - byte array value to encode, may be null</dd><dd><code>valueOffset</code> - offset into byte array</dd><dd><code>valueLength</code> - length of data in byte array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes needed to encode</dd></dl> +</li> +</ul> +<a name="encode(java.lang.String, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encode</h4> +<pre>public static int encode(java.lang.String value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional String into a variable amount of bytes. The + amount written can be determined by calling + calculateEncodedStringLength. + <p> + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are usually written in one byte. This encoding is more + efficient than UTF-8, but it isn't compatible with UTF-8.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="encodeDesc(java.lang.String, byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeDesc</h4> +<pre>public static int encodeDesc(java.lang.String value, + byte[] dst, + int dstOffset)</pre> +<div class="block">Encodes the given optional String into a variable amount of bytes for + descending order. The amount written can be determined by calling + calculateEncodedStringLength. + <p> + Strings are encoded in a fashion similar to UTF-8, in that ASCII + characters are usually written in one byte. This encoding is more + efficient than UTF-8, but it isn't compatible with UTF-8.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String value to encode, may be null</dd><dd><code>dst</code> - destination for encoded bytes</dd><dd><code>dstOffset</code> - offset into destination array</dd> +<dt><span class="strong">Returns:</span></dt><dd>amount of bytes written</dd></dl> +</li> +</ul> +<a name="calculateEncodedStringLength(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateEncodedStringLength</h4> +<pre>public static int calculateEncodedStringLength(java.lang.String value)</pre> +<div class="block">Returns the amount of bytes required to encode the given String.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - String to encode, may be null</dd></dl> +</li> +</ul> +<a name="encodeSingleDesc(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSingleDesc</h4> +<pre>public static byte[] encodeSingleDesc(byte[] value)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array. The + original byte array is returned if the length is zero.</div> +</li> +</ul> +<a name="encodeSingleDesc(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSingleDesc</h4> +<pre>public static byte[] encodeSingleDesc(byte[] value, + int prefixPadding, + int suffixPadding)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array. The + original byte array is returned if the length and padding lengths are + zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to allocate at start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to allocate at end of encoded byte array</dd></dl> +</li> +</ul> +<a name="encodeSingleNullableDesc(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeSingleNullableDesc</h4> +<pre>public static byte[] encodeSingleNullableDesc(byte[] value)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.</div> +</li> +</ul> +<a name="encodeSingleNullableDesc(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>encodeSingleNullableDesc</h4> +<pre>public static byte[] encodeSingleNullableDesc(byte[] value, + int prefixPadding, + int suffixPadding)</pre> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefixPadding</code> - amount of extra bytes to allocate at start of encoded byte array</dd><dd><code>suffixPadding</code> - amount of extra bytes to allocate at end of encoded byte array</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/KeyEncoder.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/KeyDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/RawCursor.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/KeyEncoder.html" target="_top">Frames</a></li> +<li><a href="KeyEncoder.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/RawCursor.html b/apidocs/com/amazon/carbonado/raw/RawCursor.html new file mode 100644 index 0000000..b11229d --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawCursor.html @@ -0,0 +1,854 @@ +<!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>RawCursor (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="RawCursor (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/RawCursor.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/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.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/RawCursor.html" target="_top">Frames</a></li> +<li><a href="RawCursor.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 RawCursor" class="title">Class RawCursor<S></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.RawCursor<S></li> +</ul> +</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/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">RawCursor<S></span> +extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><S></pre> +<div class="block">Abstract Cursor implementation for a repository that manipulates raw bytes.</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"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.util.concurrent.locks.Lock</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#mLock">mLock</a></strong></code> +<div class="block">Lock object, as passed into the constructor</div> +</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#RawCursor(java.util.concurrent.locks.Lock, byte[], boolean, byte[], boolean, int, boolean)">RawCursor</a></strong>(java.util.concurrent.locks.Lock lock, + byte[] startBound, + boolean inclusiveStart, + byte[] endBound, + boolean inclusiveEnd, + int maxPrefix, + boolean reverse)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#close()">close</a></strong>()</code> +<div class="block">Call close to release any resources being held by this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#compareKeysPartially(byte[], byte[])">compareKeysPartially</a></strong>(byte[] key1, + byte[] key2)</code> +<div class="block">Returns <0 if key1 is less, 0 if equal (at least partially), + >0 if key1 is greater.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#disableKeyAndValue()">disableKeyAndValue</a></strong>()</code> +<div class="block">An optimization hint which disables key and value acquisition.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#disableValue()">disableValue</a></strong>()</code> +<div class="block">An optimization hint which disables just value acquisition.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#enableKeyAndValue()">enableKeyAndValue</a></strong>()</code> +<div class="block">Enable key and value acquisition again, after they have been + disabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#getCurrentKey()">getCurrentKey</a></strong>()</code> +<div class="block">Returns the contents of the current key being referenced, or null + otherwise.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#getCurrentValue()">getCurrentValue</a></strong>()</code> +<div class="block">Returns the contents of the current value being referenced, or null + otherwise.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#handleNoSuchElement()">handleNoSuchElement</a></strong>()</code> +<div class="block">Called right before throwing NoSuchElementException.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#hasNext()">hasNext</a></strong>()</code> +<div class="block">Returns true if this cursor has more elements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#instantiateCurrent()">instantiateCurrent</a></strong>()</code> +<div class="block">Returns a new Storable instance for the currently referenced entry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#next()">next</a></strong>()</code> +<div class="block">Returns the next element from this cursor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#release()">release</a></strong>()</code> +<div class="block">Release any internal resources, called when closed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#skipNext(int)">skipNext</a></strong>(int amount)</code> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toFirst()">toFirst</a></strong>()</code> +<div class="block">Move the cursor to the first available entry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toFirst(byte[])">toFirst</a></strong>(byte[] key)</code> +<div class="block">Move the cursor to the first available entry at or after the given + key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toLast()">toLast</a></strong>()</code> +<div class="block">Move the cursor to the last available entry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toLast(byte[])">toLast</a></strong>(byte[] key)</code> +<div class="block">Move the cursor to the last available entry at or before the given + key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNext()">toNext</a></strong>()</code> +<div class="block">Move the cursor to the next available entry, returning false if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNext(int)">toNext</a></strong>(int amount)</code> +<div class="block">Move the cursor to the next available entry, incrementing by the amount + given.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toNextKey()">toNextKey</a></strong>()</code> +<div class="block">Move the cursor to the next unique key, returning false if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPrevious()">toPrevious</a></strong>()</code> +<div class="block">Move the cursor to the previous available entry, returning false if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPrevious(int)">toPrevious</a></strong>(int amount)</code> +<div class="block">Move the cursor to the previous available entry, decrementing by the + amount given.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawCursor.html#toPreviousKey()">toPreviousKey</a></strong>()</code> +<div class="block">Move the cursor to the previous unique key, returning false if none.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3> +<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li> +</ul> +<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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="mLock"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>mLock</h4> +<pre>protected final java.util.concurrent.locks.Lock mLock</pre> +<div class="block">Lock object, as passed into the constructor</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="RawCursor(java.util.concurrent.locks.Lock, byte[], boolean, byte[], boolean, int, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RawCursor</h4> +<pre>protected RawCursor(java.util.concurrent.locks.Lock lock, + byte[] startBound, + boolean inclusiveStart, + byte[] endBound, + boolean inclusiveEnd, + int maxPrefix, + boolean reverse)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lock</code> - operations lock on this object</dd><dd><code>startBound</code> - specify the starting key for the cursor, or null if first</dd><dd><code>inclusiveStart</code> - true if start bound is inclusive</dd><dd><code>endBound</code> - specify the ending key for the cursor, or null if last</dd><dd><code>inclusiveEnd</code> - true if end bound is inclusive</dd><dd><code>maxPrefix</code> - maximum expected common initial bytes in start and end bound</dd><dd><code>reverse</code> - when true, iteration is reversed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any bound is null but is not inclusive</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="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + 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/Cursor.html#close()">Cursor</a></code></strong></div> +<div class="block">Call close to release any resources being held by this cursor. Further + operations on this cursor will behave as if there are no results.</div> +<dl><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="hasNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>public boolean hasNext() + 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/Cursor.html#hasNext()">Cursor</a></code></strong></div> +<div class="block">Returns true if this cursor has more elements. In other words, returns + true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing + an exception.</div> +<dl><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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="next()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public <a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a> next() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + java.util.NoSuchElementException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Cursor.html#next()">Cursor</a></code></strong></div> +<div class="block">Returns the next element from this cursor. This method may be called + repeatedly to iterate through the results.</div> +<dl><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> - if storage layer throws an exception</dd> +<dd><code>java.util.NoSuchElementException</code> - if the cursor has no next element.</dd></dl> +</li> +</ul> +<a name="skipNext(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipNext</h4> +<pre>public int skipNext(int amount) + 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/Cursor.html#skipNext(int)">Cursor</a></code></strong></div> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped. The actual amount is less than the requested amount only + if the end of the results was reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code> in class <code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a><<a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="release()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>release</h4> +<pre>protected abstract void release() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Release any internal resources, called when closed.</div> +<dl><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="getCurrentKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentKey</h4> +<pre>protected abstract byte[] getCurrentKey() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the contents of the current key being referenced, or null + otherwise. Caller is responsible for making a copy of the key. The array + must not be modified concurrently. + + <p>If cursor is not opened, null must be returned.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>currently referenced key bytes or null if no current</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if key is disabled</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="getCurrentValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentValue</h4> +<pre>protected abstract byte[] getCurrentValue() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the contents of the current value being referenced, or null + otherwise. Caller is responsible for making a copy of the value. The + array must not be modified concurrently. + + <p>If cursor is not opened, null must be returned.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>currently referenced value bytes or null if no current</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if value is disabled</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="disableKeyAndValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disableKeyAndValue</h4> +<pre>protected void disableKeyAndValue()</pre> +<div class="block">An optimization hint which disables key and value acquisition. The + default implementation of this method does nothing.</div> +</li> +</ul> +<a name="disableValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disableValue</h4> +<pre>protected void disableValue()</pre> +<div class="block">An optimization hint which disables just value acquisition. The default + implementation of this method does nothing.</div> +</li> +</ul> +<a name="enableKeyAndValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enableKeyAndValue</h4> +<pre>protected void enableKeyAndValue() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Enable key and value acquisition again, after they have been + disabled. Calling this method forces the key and value to be + re-acquired, if they had been disabled. Key and value acquisition must + be enabled by default. The default implementation of this method does + nothing.</div> +<dl><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="instantiateCurrent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiateCurrent</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a> instantiateCurrent() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a new Storable instance for the currently referenced entry.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>new Storable instance, never null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no current entry to instantiate</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toFirst()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toFirst</h4> +<pre>protected abstract boolean toFirst() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the first available entry. If false is returned, the + cursor must be positioned before the first available entry.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if first entry exists and is now current</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toFirst(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toFirst</h4> +<pre>protected abstract boolean toFirst(byte[] key) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the first available entry at or after the given + key. If false is returned, the cursor must be positioned before the + first available entry. Caller is responsible for preserving contents of + array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key to search for</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if first entry exists and is now current</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toLast()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toLast</h4> +<pre>protected abstract boolean toLast() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the last available entry. If false is returned, the + cursor must be positioned after the last available entry.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if last entry exists and is now current</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toLast(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toLast</h4> +<pre>protected abstract boolean toLast(byte[] key) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the last available entry at or before the given + key. If false is returned, the cursor must be positioned after the last + available entry. Caller is responsible for preserving contents of array.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key to search for</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if last entry exists and is now current</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toNext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toNext</h4> +<pre>protected abstract boolean toNext() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the next available entry, returning false if none. If + false is returned, the cursor must be positioned after the last + available entry.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if moved to next entry</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toNext(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toNext</h4> +<pre>protected int toNext(int amount) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the next available entry, incrementing by the amount + given. The actual amount incremented is returned. If the amount is less + then requested, the cursor must be positioned after the last available + entry. Subclasses may wish to override this method with a faster + implementation. + + <p>Calling to toNext(1) is equivalent to calling toNext().</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - positive amount to advance</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount advanced</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toNextKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toNextKey</h4> +<pre>protected boolean toNextKey() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the next unique key, returning false if none. If + false is returned, the cursor must be positioned after the last + available entry. Subclasses may wish to override this method with a + faster implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if moved to next unique key</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toPrevious()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toPrevious</h4> +<pre>protected abstract boolean toPrevious() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the previous available entry, returning false if + none. If false is returned, the cursor must be positioned before the + first available entry.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if moved to previous entry</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toPrevious(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toPrevious</h4> +<pre>protected int toPrevious(int amount) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the previous available entry, decrementing by the + amount given. The actual amount decremented is returned. If the amount + is less then requested, the cursor must be positioned before the first + available entry. Subclasses may wish to override this method with a + faster implementation. + + <p>Calling to toPrevious(1) is equivalent to calling toPrevious().</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - positive amount to retreat</dd> +<dt><span class="strong">Returns:</span></dt><dd>actual amount retreated</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toPreviousKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toPreviousKey</h4> +<pre>protected boolean toPreviousKey() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Move the cursor to the previous unique key, returning false if none. If + false is returned, the cursor must be positioned before the first + available entry. Subclasses may wish to override this method with a + faster implementation.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if moved to previous unique key</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if cursor is not opened</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="compareKeysPartially(byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareKeysPartially</h4> +<pre>protected int compareKeysPartially(byte[] key1, + byte[] key2)</pre> +<div class="block">Returns <0 if key1 is less, 0 if equal (at least partially), + >0 if key1 is greater.</div> +</li> +</ul> +<a name="handleNoSuchElement()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>handleNoSuchElement</h4> +<pre>protected void handleNoSuchElement() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Called right before throwing NoSuchElementException. Subclasses may + override to do special checks or throw a different exception.</div> +<dl><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> +</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/RawCursor.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/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.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/RawCursor.html" target="_top">Frames</a></li> +<li><a href="RawCursor.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html b/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html new file mode 100644 index 0000000..f4fe114 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawStorableGenerator.html @@ -0,0 +1,365 @@ +<!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>RawStorableGenerator (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="RawStorableGenerator (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/RawStorableGenerator.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/RawCursor.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/RawSupport.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/RawStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="RawStorableGenerator.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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="Class RawStorableGenerator" class="title">Class RawStorableGenerator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.RawStorableGenerator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">RawStorableGenerator</span> +extends java.lang.Object</pre> +<div class="block">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + which are encoded and decoded in a raw format. The generated abstract + classes extend those created by <a href="../../../../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</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/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw"><code>GenericStorableCodec</code></a>, +<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html#DECODE_DATA_METHOD_NAME">DECODE_DATA_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html#DECODE_KEY_METHOD_NAME">DECODE_KEY_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html#ENCODE_DATA_METHOD_NAME">ENCODE_DATA_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html#ENCODE_KEY_METHOD_NAME">ENCODE_KEY_METHOD_NAME</a></strong></code> +<div class="block">Name of protected abstract method in generated storable</div> +</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>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.lang.Class<? extends S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html#getAbstractClass(java.lang.Class, boolean)">getAbstractClass</a></strong>(java.lang.Class<S> type, + boolean isMaster)</code> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="ENCODE_KEY_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ENCODE_KEY_METHOD_NAME</h4> +<pre>public static final java.lang.String ENCODE_KEY_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.raw.RawStorableGenerator.ENCODE_KEY_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DECODE_KEY_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DECODE_KEY_METHOD_NAME</h4> +<pre>public static final java.lang.String DECODE_KEY_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.raw.RawStorableGenerator.DECODE_KEY_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ENCODE_DATA_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ENCODE_DATA_METHOD_NAME</h4> +<pre>public static final java.lang.String ENCODE_DATA_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.raw.RawStorableGenerator.ENCODE_DATA_METHOD_NAME">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DECODE_DATA_METHOD_NAME"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DECODE_DATA_METHOD_NAME</h4> +<pre>public static final java.lang.String DECODE_DATA_METHOD_NAME</pre> +<div class="block">Name of protected abstract method in generated storable</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.raw.RawStorableGenerator.DECODE_DATA_METHOD_NAME">Constant Field Values</a></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="getAbstractClass(java.lang.Class, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAbstractClass</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> java.lang.Class<? extends S> getAbstractClass(java.lang.Class<S> type, + boolean isMaster) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + java.lang.IllegalArgumentException</pre> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe. The Storable type itself may be an interface or a + class. If it is a class, then it must not be final, and it must have a + public, no-arg constructor. Three constructors are defined for the + abstract implementation: + + <pre> + public <init>(RawSupport); + + public <init>(RawSupport, byte[] key); + + public <init>(RawSupport, byte[] key, byte[] value); + </pre> + + <p>Subclasses must implement the following abstract protected methods, + whose exact names are defined by constants in this class: + + <pre> + // Encode the primary key of this storable. + protected abstract byte[] encodeKey(); + + // Encode all properties of this storable excluding the primary key. + protected abstract byte[] encodeData(); + + // Decode the primary key into properties of this storable. + // Note: this method is also invoked by the three argument constructor. + protected abstract void decodeKey(byte[]); + + // Decode the data into properties of this storable. + // Note: this method is also invoked by the three argument constructor. + protected abstract void decodeData(byte[]); + </pre></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isMaster</code> - when true, version properties, sequences, and triggers are managed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</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/RawStorableGenerator.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/RawCursor.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/RawSupport.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/RawStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="RawStorableGenerator.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/raw/RawSupport.html b/apidocs/com/amazon/carbonado/raw/RawSupport.html new file mode 100644 index 0000000..b8aa31a --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawSupport.html @@ -0,0 +1,452 @@ +<!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> diff --git a/apidocs/com/amazon/carbonado/raw/RawUtil.html b/apidocs/com/amazon/carbonado/raw/RawUtil.html new file mode 100644 index 0000000..2ff4fd1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/RawUtil.html @@ -0,0 +1,286 @@ +<!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>RawUtil (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="RawUtil (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/RawUtil.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/RawSupport.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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/RawUtil.html" target="_top">Frames</a></li> +<li><a href="RawUtil.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><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 RawUtil" class="title">Class RawUtil</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.RawUtil</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">RawUtil</span> +extends java.lang.Object</pre> +<div class="block">Utilities for manipulating binary data.</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"> +<!-- ======== 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/RawUtil.html#RawUtil()">RawUtil</a></strong>()</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>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawUtil.html#decrement(byte[])">decrement</a></strong>(byte[] value)</code> +<div class="block">Subtracts one from an unsigned integer, represented as a byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/RawUtil.html#increment(byte[])">increment</a></strong>(byte[] value)</code> +<div class="block">Adds one to an unsigned integer, represented as a byte array.</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> +</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="RawUtil()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RawUtil</h4> +<pre>public RawUtil()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="increment(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>increment</h4> +<pre>public static boolean increment(byte[] value)</pre> +<div class="block">Adds one to an unsigned integer, represented as a byte array. If + overflowed, value in byte array is 0x00, 0x00, 0x00...</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - unsigned integer to increment</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if overflowed</dd></dl> +</li> +</ul> +<a name="decrement(byte[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decrement</h4> +<pre>public static boolean decrement(byte[] value)</pre> +<div class="block">Subtracts one from an unsigned integer, represented as a byte array. If + overflowed, value in byte array is 0xff, 0xff, 0xff...</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - unsigned integer to decrement</dd> +<dt><span class="strong">Returns:</span></dt><dd>false if overflowed</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/RawUtil.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/RawSupport.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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/RawUtil.html" target="_top">Frames</a></li> +<li><a href="RawUtil.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><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> diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodec.html b/apidocs/com/amazon/carbonado/raw/StorableCodec.html new file mode 100644 index 0000000..f647b5b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodec.html @@ -0,0 +1,529 @@ +<!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>StorableCodec (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="StorableCodec (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/StorableCodec.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/RawUtil.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.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/StorableCodec.html" target="_top">Frames</a></li> +<li><a href="StorableCodec.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 StorableCodec" class="title">Interface StorableCodec<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 Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a>, <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableCodec<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Supports encoding and decoding of storables.</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/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodecFactory</code></a></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/StorableCodec.html#decode(S, int, byte[])">decode</a></strong>(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[], int, int)">encodePrimaryKey</a></strong>(java.lang.Object[] values, + int rangeStart, + int rangeEnd)</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/StorableCodec.html#encodePrimaryKey(S)">encodePrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S, int, int)">encodePrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> storable, + int rangeStart, + int rangeEnd)</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/StorableCodec.html#encodePrimaryKeyPrefix()">encodePrimaryKeyPrefix</a></strong>()</code> +<div class="block">Encode the primary key for when there are no values, but there may be a + prefix.</div> +</td> +</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/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength</a></strong>()</code> +<div class="block">Returns the number of prefix bytes in the primary key, which may be + zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the type of Storable produced by this codec.</div> +</td> +</tr> +<tr class="rowColor"> +<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/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate()">instantiate</a></strong>()</code> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[])">instantiate</a></strong>(byte[] key)</code> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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/StorableCodec.html" title="type parameter in StorableCodec">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/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodec.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/StorableCodec.html" title="type parameter in StorableCodec">S</a>> support, + byte[] key, + byte[] value)</code> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</td> +</tr> +</table> +</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="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> getStorableType()</pre> +<div class="block">Returns the type of Storable produced by this codec.</div> +</li> +</ul> +<a name="instantiate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> instantiate()</pre> +<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><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no default support exists</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="instantiate(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> instantiate(byte[] key) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Instantiate a Storable with no 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><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no default support exists</dd> +<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(byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>instantiate</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">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">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><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if no default support exists</dd> +<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><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">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/StorableCodec.html" title="type parameter in StorableCodec">S</a>> support)</pre> +<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><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><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">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/StorableCodec.html" title="type parameter in StorableCodec">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">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><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="getPrimaryKeyIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyIndex</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> getPrimaryKeyIndex()</pre> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</li> +</ul> +<a name="getPrimaryKeyPrefixLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyPrefixLength</h4> +<pre>int getPrimaryKeyPrefixLength()</pre> +<div class="block">Returns the number of prefix bytes in the primary key, which may be + zero.</div> +</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>byte[] encodePrimaryKey(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> storable)</pre> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl><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(com.amazon.carbonado.Storable,int,int)"> +<!-- --> +</a><a name="encodePrimaryKey(S, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>byte[] encodePrimaryKey(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> storable, + int rangeStart, + int rangeEnd)</pre> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storable</code> - extract primary key properties from this instance</dd><dd><code>rangeStart</code> - index of first property to use. Its value must be less + than the count of primary key properties.</dd><dd><code>rangeEnd</code> - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.</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>byte[] encodePrimaryKey(java.lang.Object[] values)</pre> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl><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="encodePrimaryKey(java.lang.Object[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKey</h4> +<pre>byte[] encodePrimaryKey(java.lang.Object[] values, + int rangeStart, + int rangeEnd)</pre> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - values to build into a key. The length may be less than + the amount of primary key properties used by this factory. It must not + be less than the difference between rangeStart and rangeEnd.</dd><dd><code>rangeStart</code> - index of first property to use. Its value must be less + than the count of primary key properties.</dd><dd><code>rangeEnd</code> - index of last property to use, exlusive. Its value must + be less than or equal to the count of primary key properties.</dd> +<dt><span class="strong">Returns:</span></dt><dd>raw search key</dd></dl> +</li> +</ul> +<a name="encodePrimaryKeyPrefix()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodePrimaryKeyPrefix</h4> +<pre>byte[] encodePrimaryKeyPrefix()</pre> +<div class="block">Encode the primary key for when there are no values, but there may be a + prefix. Returned value may be null if no prefix is defined.</div> +</li> +</ul> +<a name="decode(com.amazon.carbonado.Storable,int,byte[])"> +<!-- --> +</a><a name="decode(S, int, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decode</h4> +<pre>void decode(<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">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> +<a name="getSupport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSupport</h4> +<pre><a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a><<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>> getSupport()</pre> +<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><span class="strong">Since:</span></dt> + <dd>1.2</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/StorableCodec.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/RawUtil.html" title="class in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.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/StorableCodec.html" target="_top">Frames</a></li> +<li><a href="StorableCodec.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> diff --git a/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html new file mode 100644 index 0000000..9a19a87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorableCodecFactory.html @@ -0,0 +1,291 @@ +<!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>StorableCodecFactory (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="StorableCodecFactory (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/StorableCodecFactory.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/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.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/StorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="StorableCodecFactory.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 StorableCodecFactory" class="title">Interface StorableCodecFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a>, <a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a>, <a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableCodecFactory</span></pre> +<div class="block">Factory for creating instances of <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodec</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><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Optionally return additional information regarding storable encoding.</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/raw/StorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName</a></strong>(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Returns the preferred storage/database name for the given type.</div> +</td> +</tr> +</table> +</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="getStorageName(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageName</h4> +<pre>java.lang.String getStorageName(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Returns the preferred storage/database name for the given type. Return + null to let repository decide.</div> +<dl><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 type is not supported</dd></dl> +</li> +</ul> +<a name="getLayoutOptions(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLayoutOptions</h4> +<pre><a href="../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> getLayoutOptions(java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<div class="block">Optionally return additional information regarding storable encoding.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createCodec</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S> createCodec(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout) + 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>type</code> - type of storable to create codec for</dd><dd><code>pkIndex</code> - suggested index for primary key (optional)</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, attempt to encode a storable layout + generation value in each storable</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 type is not supported</dd></dl> +</li> +</ul> +<a name="createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createCodec</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S> createCodec(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</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>type</code> - type of storable to create codec for</dd><dd><code>pkIndex</code> - suggested index for primary key (optional)</dd><dd><code>isMaster</code> - when true, version properties and sequences are managed</dd><dd><code>layout</code> - when non-null, attempt to encode a storable layout + generation value in each storable</dd><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/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code> - if type is not supported</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</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/StorableCodecFactory.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/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.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/StorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="StorableCodecFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html b/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html new file mode 100644 index 0000000..02749bc --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/StorablePropertyInfo.html @@ -0,0 +1,474 @@ +<!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>StorablePropertyInfo (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="StorablePropertyInfo (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/StorablePropertyInfo.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/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/StorablePropertyInfo.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyInfo.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="Class StorablePropertyInfo" class="title">Class StorablePropertyInfo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.raw.StorablePropertyInfo</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/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyInfo</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></pre> +<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/StorablePropertyInfo.html#addInvokeReadMethod(org.cojen.classfile.CodeAssembler)">addInvokeReadMethod</a></strong>(org.cojen.classfile.CodeAssembler a)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeReadMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)">addInvokeReadMethod</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeWriteMethod(org.cojen.classfile.CodeAssembler)">addInvokeWriteMethod</a></strong>(org.cojen.classfile.CodeAssembler a)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeWriteMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)">addInvokeWriteMethod</a></strong>(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter</a></strong>()</code> +<div class="block">Returns the optional method used to adapt the property from the + storage supported type to the user visible type.</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/raw/StorablePropertyInfo.html#getPropertyName()">getPropertyName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.cojen.classfile.TypeDesc</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getPropertyType()">getPropertyType</a></strong>()</code> +<div class="block">Returns the user specified property type.</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/raw/StorablePropertyInfo.html#getReadMethodName()">getReadMethodName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.cojen.classfile.TypeDesc</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getStorageType()">getStorageType</a></strong>()</code> +<div class="block">Returns the storage supported type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#getToStorageAdapter()">getToStorageAdapter</a></strong>()</code> +<div class="block">Returns the optional method used to adapt the property from the user + visible type to the storage supported type.</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/raw/StorablePropertyInfo.html#getWriteMethodName()">getWriteMethodName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#isDerived()">isDerived</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#isLob()">isLob</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#isNullable()">isNullable</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html#toString()">toString</a></strong>()</code> </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, wait, wait, wait</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="getPropertyName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyName</h4> +<pre>public java.lang.String getPropertyName()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyName()">getPropertyName</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getPropertyType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyType</h4> +<pre>public org.cojen.classfile.TypeDesc getPropertyType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyType()">GenericPropertyInfo</a></code></strong></div> +<div class="block">Returns the user specified property type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyType()">getPropertyType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getStorageType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageType</h4> +<pre>public org.cojen.classfile.TypeDesc getStorageType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getStorageType()">GenericPropertyInfo</a></code></strong></div> +<div class="block">Returns the storage supported type. If it differs from the property + type, then adapter methods must also exist.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getStorageType()">getStorageType</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>public boolean isNullable()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isNullable()">isNullable</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isLob()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLob</h4> +<pre>public boolean isLob()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isLob()">isLob</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDerived</h4> +<pre>public boolean isDerived()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#isDerived()">isDerived</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getFromStorageAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFromStorageAdapter</h4> +<pre>public java.lang.reflect.Method getFromStorageAdapter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getFromStorageAdapter()">GenericPropertyInfo</a></code></strong></div> +<div class="block">Returns the optional method used to adapt the property from the + storage supported type to the user visible type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getToStorageAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getToStorageAdapter</h4> +<pre>public java.lang.reflect.Method getToStorageAdapter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getToStorageAdapter()">GenericPropertyInfo</a></code></strong></div> +<div class="block">Returns the optional method used to adapt the property from the user + visible type to the storage supported type.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html#getToStorageAdapter()">getToStorageAdapter</a></code> in interface <code><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getReadMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadMethodName</h4> +<pre>public java.lang.String getReadMethodName()</pre> +</li> +</ul> +<a name="addInvokeReadMethod(org.cojen.classfile.CodeAssembler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInvokeReadMethod</h4> +<pre>public void addInvokeReadMethod(org.cojen.classfile.CodeAssembler a)</pre> +</li> +</ul> +<a name="addInvokeReadMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInvokeReadMethod</h4> +<pre>public void addInvokeReadMethod(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType)</pre> +</li> +</ul> +<a name="getWriteMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteMethodName</h4> +<pre>public java.lang.String getWriteMethodName()</pre> +</li> +</ul> +<a name="addInvokeWriteMethod(org.cojen.classfile.CodeAssembler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInvokeWriteMethod</h4> +<pre>public void addInvokeWriteMethod(org.cojen.classfile.CodeAssembler a)</pre> +</li> +</ul> +<a name="addInvokeWriteMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addInvokeWriteMethod</h4> +<pre>public void addInvokeWriteMethod(org.cojen.classfile.CodeAssembler a, + org.cojen.classfile.TypeDesc instanceType)</pre> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/StorablePropertyInfo.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/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/StorablePropertyInfo.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyInfo.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/CompressedEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/class-use/CompressedEncodingStrategy.html new file mode 100644 index 0000000..1365205 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/CompressedEncodingStrategy.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.CompressedEncodingStrategy (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="Uses of Class com.amazon.carbonado.raw.CompressedEncodingStrategy (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><a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CompressedEncodingStrategy.html" target="_top">Frames</a></li> +<li><a href="CompressedEncodingStrategy.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.CompressedEncodingStrategy" class="title">Uses of Class<br>com.amazon.carbonado.raw.CompressedEncodingStrategy</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.CompressedEncodingStrategy</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CompressedEncodingStrategy.html" target="_top">Frames</a></li> +<li><a href="CompressedEncodingStrategy.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/CompressedStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/CompressedStorableCodecFactory.html new file mode 100644 index 0000000..c260151 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/CompressedStorableCodecFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.CompressedStorableCodecFactory (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="Uses of Class com.amazon.carbonado.raw.CompressedStorableCodecFactory (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><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CompressedStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="CompressedStorableCodecFactory.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.CompressedStorableCodecFactory" class="title">Uses of Class<br>com.amazon.carbonado.raw.CompressedStorableCodecFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.CompressedStorableCodecFactory</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CompressedStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="CompressedStorableCodecFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/CompressionType.html b/apidocs/com/amazon/carbonado/raw/class-use/CompressionType.html new file mode 100644 index 0000000..b74aa73 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/CompressionType.html @@ -0,0 +1,197 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.CompressionType (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="Uses of Class com.amazon.carbonado.raw.CompressionType (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><a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CompressionType.html" target="_top">Frames</a></li> +<li><a href="CompressionType.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.CompressionType" class="title">Uses of Class<br>com.amazon.carbonado.raw.CompressionType</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getCompressionType(java.lang.Class)">getCompressionType</a></strong>(java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></code></td> +<td class="colLast"><span class="strong">CompressionType.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressionType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>[]</code></td> +<td class="colLast"><span class="strong">CompressionType.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressionType.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#CompressedEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.raw.CompressionType)">CompressedEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> pkIndex, + <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> compressionType)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructor parameters in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with type arguments of type <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#CompressedStorableCodecFactory(java.util.Map)">CompressedStorableCodecFactory</a></strong>(java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a>> compressionMap)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CompressionType.html" target="_top">Frames</a></li> +<li><a href="CompressionType.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.InstanceFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.InstanceFactory.html new file mode 100644 index 0000000..087f5c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.InstanceFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory (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="Uses of Interface com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory (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><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CustomStorableCodec.InstanceFactory.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodec.InstanceFactory.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"> +<h2 title="Uses of Interface com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory" class="title">Uses of Interface<br>com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.CustomStorableCodec.InstanceFactory</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CustomStorableCodec.InstanceFactory.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodec.InstanceFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.html b/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.html new file mode 100644 index 0000000..aa1e7ff --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodec.html @@ -0,0 +1,205 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.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="Uses of Class com.amazon.carbonado.raw.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><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.raw.CustomStorableCodec" class="title">Uses of Class<br>com.amazon.carbonado.raw.CustomStorableCodec</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.InstanceFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[], com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key, + byte[] value, + <a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.InstanceFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + <a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodecFactory.html new file mode 100644 index 0000000..3372e8c --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/CustomStorableCodecFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.CustomStorableCodecFactory (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="Uses of Class com.amazon.carbonado.raw.CustomStorableCodecFactory (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><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CustomStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodecFactory.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.CustomStorableCodecFactory" class="title">Uses of Class<br>com.amazon.carbonado.raw.CustomStorableCodecFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.CustomStorableCodecFactory</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/CustomStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="CustomStorableCodecFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/DataDecoder.html b/apidocs/com/amazon/carbonado/raw/class-use/DataDecoder.html new file mode 100644 index 0000000..d0bf584 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/DataDecoder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.DataDecoder (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="Uses of Class com.amazon.carbonado.raw.DataDecoder (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><a href="../../../../../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/DataDecoder.html" target="_top">Frames</a></li> +<li><a href="DataDecoder.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.DataDecoder" class="title">Uses of Class<br>com.amazon.carbonado.raw.DataDecoder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.DataDecoder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/DataDecoder.html" target="_top">Frames</a></li> +<li><a href="DataDecoder.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/DataEncoder.html b/apidocs/com/amazon/carbonado/raw/class-use/DataEncoder.html new file mode 100644 index 0000000..6bd4062 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/DataEncoder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.DataEncoder (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="Uses of Class com.amazon.carbonado.raw.DataEncoder (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><a href="../../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/DataEncoder.html" target="_top">Frames</a></li> +<li><a href="DataEncoder.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.DataEncoder" class="title">Uses of Class<br>com.amazon.carbonado.raw.DataEncoder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.DataEncoder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/DataEncoder.html" target="_top">Frames</a></li> +<li><a href="DataEncoder.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html new file mode 100644 index 0000000..68d3703 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html @@ -0,0 +1,192 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.GenericEncodingStrategy (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="Uses of Class com.amazon.carbonado.raw.GenericEncodingStrategy (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><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html" target="_top">Frames</a></li> +<li><a href="GenericEncodingStrategy.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.GenericEncodingStrategy" class="title">Uses of Class<br>com.amazon.carbonado.raw.GenericEncodingStrategy</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Extension of GenericEncodingStrategy that allows for compression.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html" target="_top">Frames</a></li> +<li><a href="GenericEncodingStrategy.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericInstanceFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericInstanceFactory.html new file mode 100644 index 0000000..10788ed --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericInstanceFactory.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.raw.GenericInstanceFactory (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="Uses of Interface com.amazon.carbonado.raw.GenericInstanceFactory (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><a href="../../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericInstanceFactory.html" target="_top">Frames</a></li> +<li><a href="GenericInstanceFactory.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"> +<h2 title="Uses of Interface com.amazon.carbonado.raw.GenericInstanceFactory" class="title">Uses of Interface<br>com.amazon.carbonado.raw.GenericInstanceFactory</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.GenericInstanceFactory</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericInstanceFactory.html" target="_top">Frames</a></li> +<li><a href="GenericInstanceFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html new file mode 100644 index 0000000..1670e50 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html @@ -0,0 +1,160 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.raw.GenericPropertyInfo (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="Uses of Interface com.amazon.carbonado.raw.GenericPropertyInfo (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><a href="../../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html" target="_top">Frames</a></li> +<li><a href="GenericPropertyInfo.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"> +<h2 title="Uses of Interface com.amazon.carbonado.raw.GenericPropertyInfo" class="title">Uses of Interface<br>com.amazon.carbonado.raw.GenericPropertyInfo</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that implement <a href="../../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></strong></code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html" target="_top">Frames</a></li> +<li><a href="GenericPropertyInfo.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html new file mode 100644 index 0000000..1b7b1c8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html @@ -0,0 +1,164 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.Decoder (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="Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.Decoder (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><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.Decoder.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"> +<h2 title="Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.Decoder" class="title">Uses of Interface<br>com.amazon.carbonado.raw.GenericStorableCodec.Decoder</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a><<a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getDecoder(int)">getDecoder</a></strong>(int generation)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use direct decode method</i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.Decoder.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html new file mode 100644 index 0000000..0b6e280 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html @@ -0,0 +1,163 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory (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="Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory (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><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.SearchKeyFactory.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"> +<h2 title="Uses of Interface com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory" class="title">Uses of Interface<br>com.amazon.carbonado.raw.GenericStorableCodec.SearchKeyFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a><<a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getSearchKeyFactory(com.amazon.carbonado.info.OrderedProperty[])">getSearchKeyFactory</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>>[] properties)</code> +<div class="block">Returns a search key factory, which is useful for implementing indexes + and queries.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.SearchKeyFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html new file mode 100644 index 0000000..44d6215 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodec.html @@ -0,0 +1,171 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.GenericStorableCodec (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="Uses of Class com.amazon.carbonado.raw.GenericStorableCodec (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><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericStorableCodec.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.GenericStorableCodec" class="title">Uses of Class<br>com.amazon.carbonado.raw.GenericStorableCodec</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericStorableCodec.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodec.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodecFactory.html new file mode 100644 index 0000000..e2d6a32 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GenericStorableCodecFactory.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.GenericStorableCodecFactory (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="Uses of Class com.amazon.carbonado.raw.GenericStorableCodecFactory (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><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodecFactory.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.GenericStorableCodecFactory" class="title">Uses of Class<br>com.amazon.carbonado.raw.GenericStorableCodecFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></strong></code> +<div class="block">Extension of GenericStorableCodecFactory that allows for compression.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GenericStorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="GenericStorableCodecFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/GzipCompressor.html b/apidocs/com/amazon/carbonado/raw/class-use/GzipCompressor.html new file mode 100644 index 0000000..36b65b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/GzipCompressor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.GzipCompressor (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="Uses of Class com.amazon.carbonado.raw.GzipCompressor (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><a href="../../../../../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GzipCompressor.html" target="_top">Frames</a></li> +<li><a href="GzipCompressor.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.GzipCompressor" class="title">Uses of Class<br>com.amazon.carbonado.raw.GzipCompressor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.GzipCompressor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/GzipCompressor.html" target="_top">Frames</a></li> +<li><a href="GzipCompressor.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/KeyDecoder.html b/apidocs/com/amazon/carbonado/raw/class-use/KeyDecoder.html new file mode 100644 index 0000000..4e70647 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/KeyDecoder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.KeyDecoder (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="Uses of Class com.amazon.carbonado.raw.KeyDecoder (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><a href="../../../../../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/KeyDecoder.html" target="_top">Frames</a></li> +<li><a href="KeyDecoder.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.KeyDecoder" class="title">Uses of Class<br>com.amazon.carbonado.raw.KeyDecoder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.KeyDecoder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/KeyDecoder.html" target="_top">Frames</a></li> +<li><a href="KeyDecoder.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/KeyEncoder.html b/apidocs/com/amazon/carbonado/raw/class-use/KeyEncoder.html new file mode 100644 index 0000000..f7f134d --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/KeyEncoder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.KeyEncoder (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="Uses of Class com.amazon.carbonado.raw.KeyEncoder (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><a href="../../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/KeyEncoder.html" target="_top">Frames</a></li> +<li><a href="KeyEncoder.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.KeyEncoder" class="title">Uses of Class<br>com.amazon.carbonado.raw.KeyEncoder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.KeyEncoder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/KeyEncoder.html" target="_top">Frames</a></li> +<li><a href="KeyEncoder.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawCursor.html b/apidocs/com/amazon/carbonado/raw/class-use/RawCursor.html new file mode 100644 index 0000000..3c80731 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawCursor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.RawCursor (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="Uses of Class com.amazon.carbonado.raw.RawCursor (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><a href="../../../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/RawCursor.html" target="_top">Frames</a></li> +<li><a href="RawCursor.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.RawCursor" class="title">Uses of Class<br>com.amazon.carbonado.raw.RawCursor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.RawCursor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/RawCursor.html" target="_top">Frames</a></li> +<li><a href="RawCursor.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawStorableGenerator.html b/apidocs/com/amazon/carbonado/raw/class-use/RawStorableGenerator.html new file mode 100644 index 0000000..5b31f74 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawStorableGenerator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.RawStorableGenerator (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="Uses of Class com.amazon.carbonado.raw.RawStorableGenerator (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><a href="../../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/RawStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="RawStorableGenerator.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.RawStorableGenerator" class="title">Uses of Class<br>com.amazon.carbonado.raw.RawStorableGenerator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.RawStorableGenerator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/RawStorableGenerator.html" target="_top">Frames</a></li> +<li><a href="RawStorableGenerator.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html b/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html new file mode 100644 index 0000000..3ca6b5e --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawSupport.html @@ -0,0 +1,289 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.raw.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="Uses of Interface com.amazon.carbonado.raw.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><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.raw.RawSupport" class="title">Uses of Interface<br>com.amazon.carbonado.raw.RawSupport</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></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> +<tbody> +<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/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.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/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"><span class="strong">CustomStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#getSupport()">getSupport</a></strong>()</code> </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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getSupport()">getSupport</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">GenericInstanceFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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> support)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.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/StorableCodec.html" title="type parameter in StorableCodec">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"><span class="strong">CustomStorableCodec.</span><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> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">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/StorableCodec.html" title="type parameter in StorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.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/StorableCodec.html" title="type parameter in StorableCodec">S</a>> support, + 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"><span class="strong">CustomStorableCodec.</span><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> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.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/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>> support, + 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/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">GenericInstanceFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[])">instantiate</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">GenericInstanceFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericInstanceFactory.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> support, + byte[] key, + byte[] value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.InstanceFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[], com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + byte[] key, + byte[] value, + <a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.InstanceFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, com.amazon.carbonado.raw.CustomStorableCodec)">instantiate</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support, + <a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a> codec)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/RawUtil.html b/apidocs/com/amazon/carbonado/raw/class-use/RawUtil.html new file mode 100644 index 0000000..a04452d --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/RawUtil.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.RawUtil (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="Uses of Class com.amazon.carbonado.raw.RawUtil (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><a href="../../../../../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/RawUtil.html" target="_top">Frames</a></li> +<li><a href="RawUtil.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.RawUtil" class="title">Uses of Class<br>com.amazon.carbonado.raw.RawUtil</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.raw.RawUtil</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/RawUtil.html" target="_top">Frames</a></li> +<li><a href="RawUtil.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html new file mode 100644 index 0000000..852c901 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodec.html @@ -0,0 +1,193 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.raw.StorableCodec (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="Uses of Interface com.amazon.carbonado.raw.StorableCodec (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><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/StorableCodec.html" target="_top">Frames</a></li> +<li><a href="StorableCodec.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"> +<h2 title="Uses of Interface com.amazon.carbonado.raw.StorableCodec" class="title">Uses of Interface<br>com.amazon.carbonado.raw.StorableCodec</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that implement <a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Allows codecs to be defined for storables that have a custom encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/StorableCodec.html" target="_top">Frames</a></li> +<li><a href="StorableCodec.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/StorableCodecFactory.html b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodecFactory.html new file mode 100644 index 0000000..c8a7efd --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/StorableCodecFactory.html @@ -0,0 +1,217 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.raw.StorableCodecFactory (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="Uses of Interface com.amazon.carbonado.raw.StorableCodecFactory (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><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/StorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="StorableCodecFactory.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"> +<h2 title="Uses of Interface com.amazon.carbonado.raw.StorableCodecFactory" class="title">Uses of Interface<br>com.amazon.carbonado.raw.StorableCodecFactory</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that implement <a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></strong></code> +<div class="block">Extension of GenericStorableCodecFactory that allows for compression.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></strong></code> +<div class="block">Factory for custom storable codecs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></strong></code> +<div class="block">Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that return <a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getStorableCodecFactory()">getStorableCodecFactory</a></strong>()</code> +<div class="block">Returns the storable codec factory used.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with parameters of type <a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setStorableCodecFactory(com.amazon.carbonado.raw.StorableCodecFactory)">setStorableCodecFactory</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> factory)</code> +<div class="block">Override the default storable codec factory.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/StorableCodecFactory.html" target="_top">Frames</a></li> +<li><a href="StorableCodecFactory.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> diff --git a/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html b/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html new file mode 100644 index 0000000..01b893b --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html @@ -0,0 +1,210 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.raw.StorablePropertyInfo (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="Uses of Class com.amazon.carbonado.raw.StorablePropertyInfo (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><a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyInfo.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"> +<h2 title="Uses of Class com.amazon.carbonado.raw.StorablePropertyInfo" class="title">Uses of Class<br>com.amazon.carbonado.raw.StorablePropertyInfo</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty)">checkSupport</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> property)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty[])">checkSupport</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#loadPropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)">loadPropertyValue</a></strong>(org.cojen.classfile.CodeAssembler a, + <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar)</code> +<div class="block">Generates code to load a property value onto the operand stack.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#loadPropertyValue(org.cojen.classfile.LocalVariable[], java.lang.Boolean[], org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)">loadPropertyValue</a></strong>(org.cojen.classfile.LocalVariable[] stashedProperties, + java.lang.Boolean[] stashedFromInstances, + org.cojen.classfile.CodeAssembler a, + <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + int ordinal, + boolean useReadMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + org.cojen.classfile.LocalVariable partialStartVar)</code> +<div class="block">Generates code to load a property value onto the operand stack.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#storePropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, boolean, org.cojen.classfile.LocalVariable, java.lang.Class)">storePropertyValue</a></strong>(org.cojen.classfile.CodeAssembler a, + <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a> info, + boolean useWriteMethod, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass)</code> +<div class="block">Generates code to store a property value into an instance which is + already on the operand stack.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyInfo.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> diff --git a/apidocs/com/amazon/carbonado/raw/package-frame.html b/apidocs/com/amazon/carbonado/raw/package-frame.html new file mode 100644 index 0000000..d4a3664 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/package-frame.html @@ -0,0 +1,50 @@ +<!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.raw (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/raw/package-summary.html" target="classFrame">com.amazon.carbonado.raw</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw" target="classFrame"><i>CustomStorableCodec.InstanceFactory</i></a></li> +<li><a href="GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw" target="classFrame"><i>GenericInstanceFactory</i></a></li> +<li><a href="GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw" target="classFrame"><i>GenericPropertyInfo</i></a></li> +<li><a href="GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw" target="classFrame"><i>GenericStorableCodec.Decoder</i></a></li> +<li><a href="GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw" target="classFrame"><i>GenericStorableCodec.SearchKeyFactory</i></a></li> +<li><a href="RawSupport.html" title="interface in com.amazon.carbonado.raw" target="classFrame"><i>RawSupport</i></a></li> +<li><a href="StorableCodec.html" title="interface in com.amazon.carbonado.raw" target="classFrame"><i>StorableCodec</i></a></li> +<li><a href="StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw" target="classFrame"><i>StorableCodecFactory</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw" target="classFrame">CompressedEncodingStrategy</a></li> +<li><a href="CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw" target="classFrame">CompressedStorableCodecFactory</a></li> +<li><a href="CustomStorableCodec.html" title="class in com.amazon.carbonado.raw" target="classFrame">CustomStorableCodec</a></li> +<li><a href="CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw" target="classFrame">CustomStorableCodecFactory</a></li> +<li><a href="DataDecoder.html" title="class in com.amazon.carbonado.raw" target="classFrame">DataDecoder</a></li> +<li><a href="DataEncoder.html" title="class in com.amazon.carbonado.raw" target="classFrame">DataEncoder</a></li> +<li><a href="GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw" target="classFrame">GenericEncodingStrategy</a></li> +<li><a href="GenericStorableCodec.html" title="class in com.amazon.carbonado.raw" target="classFrame">GenericStorableCodec</a></li> +<li><a href="GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw" target="classFrame">GenericStorableCodecFactory</a></li> +<li><a href="GzipCompressor.html" title="class in com.amazon.carbonado.raw" target="classFrame">GzipCompressor</a></li> +<li><a href="KeyDecoder.html" title="class in com.amazon.carbonado.raw" target="classFrame">KeyDecoder</a></li> +<li><a href="KeyEncoder.html" title="class in com.amazon.carbonado.raw" target="classFrame">KeyEncoder</a></li> +<li><a href="RawCursor.html" title="class in com.amazon.carbonado.raw" target="classFrame">RawCursor</a></li> +<li><a href="RawStorableGenerator.html" title="class in com.amazon.carbonado.raw" target="classFrame">RawStorableGenerator</a></li> +<li><a href="RawUtil.html" title="class in com.amazon.carbonado.raw" target="classFrame">RawUtil</a></li> +<li><a href="StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw" target="classFrame">StorablePropertyInfo</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="CompressionType.html" title="enum in com.amazon.carbonado.raw" target="classFrame">CompressionType</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/raw/package-summary.html b/apidocs/com/amazon/carbonado/raw/package-summary.html new file mode 100644 index 0000000..005f986 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/package-summary.html @@ -0,0 +1,319 @@ +<!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.raw (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.raw (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><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/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.raw</h1> +<div class="docSummary"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</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/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">CustomStorableCodec.InstanceFactory</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">GenericInstanceFactory</a></td> +<td class="colLast"> +<div class="block">Can be used with <a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><code>QuickConstructorGenerator</code></a> + for instantiating generic storable instances.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></td> +<td class="colLast"> +<div class="block">Minimal information required by <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><code>GenericEncodingStrategy</code></a> to encode + and decode a storable property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</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">Used for decoding different generations of Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</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">Creates custom raw search keys for <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</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">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> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</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 encoding and decoding of storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></td> +<td class="colLast"> +<div class="block">Factory for creating instances of <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodec</code></a>.</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/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</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">Extension of GenericEncodingStrategy that allows for compression.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></td> +<td class="colLast"> +<div class="block">Extension of GenericStorableCodecFactory that allows for compression.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</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">Allows codecs to be defined for storables that have a custom encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></td> +<td class="colLast"> +<div class="block">Factory for custom storable codecs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></td> +<td class="colLast"> +<div class="block">A very low-level class that decodes key components encoded by methods of + <a href="../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw"><code>DataEncoder</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></td> +<td class="colLast"> +<div class="block">A very low-level class that supports encoding of primitive data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</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">Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</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">Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></td> +<td class="colLast"> +<div class="block">Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw">GzipCompressor</a></td> +<td class="colLast"> +<div class="block">Raw-level data compression using gzip.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></td> +<td class="colLast"> +<div class="block">A very low-level class that decodes key components encoded by methods of + <a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><code>KeyEncoder</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></td> +<td class="colLast"> +<div class="block">A very low-level class that supports encoding of primitive data into unique, + sortable byte array keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a><S></td> +<td class="colLast"> +<div class="block">Abstract Cursor implementation for a repository that manipulates raw bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">RawStorableGenerator</a></td> +<td class="colLast"> +<div class="block">Generates and caches abstract implementations of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + which are encoded and decoded in a raw format.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw">RawUtil</a></td> +<td class="colLast"> +<div class="block">Utilities for manipulating binary data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></td> +<td class="colLast"> </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/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></td> +<td class="colLast"> +<div class="block">Available compression types for any particular storable.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.raw Description">Package com.amazon.carbonado.raw Description</h2> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</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><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/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> diff --git a/apidocs/com/amazon/carbonado/raw/package-tree.html b/apidocs/com/amazon/carbonado/raw/package-tree.html new file mode 100644 index 0000000..bb6c70a --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/package-tree.html @@ -0,0 +1,190 @@ +<!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.raw Class Hierarchy (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.raw Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/qe/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/repo/indexed/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.raw</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">AbstractCursor</span></a><S> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S>) +<ul> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw"><span class="strong">RawCursor</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">CustomStorableCodec</span></a><S> (implements com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S>)</li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">CustomStorableCodecFactory</span></a> (implements com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a>)</li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">DataDecoder</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">DataEncoder</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericEncodingStrategy</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">CompressedEncodingStrategy</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec</span></a><S> (implements com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S>)</li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodecFactory</span></a> (implements com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a>) +<ul> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">CompressedStorableCodecFactory</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw"><span class="strong">GzipCompressor</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">KeyDecoder</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">KeyEncoder</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><span class="strong">RawStorableGenerator</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw"><span class="strong">RawUtil</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw"><span class="strong">StorablePropertyInfo</span></a> (implements com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">CustomStorableCodec.InstanceFactory</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericInstanceFactory</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericPropertyInfo</span></a></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec.Decoder</span></a><S></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec.SearchKeyFactory</span></a><S></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><span class="strong">StorableCodec</span></a><S></li> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">StorableCodecFactory</span></a></li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">StorableSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">TriggerSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">MasterSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><span class="strong">RawSupport</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.raw.<a href="../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw"><span class="strong">CompressionType</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/qe/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/repo/indexed/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/raw/package-use.html b/apidocs/com/amazon/carbonado/raw/package-use.html new file mode 100644 index 0000000..8024cb2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/package-use.html @@ -0,0 +1,236 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.raw (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="Uses of Package com.amazon.carbonado.raw (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.raw" class="title">Uses of Package<br>com.amazon.carbonado.raw</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/CompressionType.html#com.amazon.carbonado.raw">CompressionType</a> +<div class="block">Available compression types for any particular storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/CustomStorableCodec.html#com.amazon.carbonado.raw">CustomStorableCodec</a> +<div class="block">Allows codecs to be defined for storables that have a custom encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/GenericEncodingStrategy.html#com.amazon.carbonado.raw">GenericEncodingStrategy</a> +<div class="block">Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/GenericPropertyInfo.html#com.amazon.carbonado.raw">GenericPropertyInfo</a> +<div class="block">Minimal information required by <a href="../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><code>GenericEncodingStrategy</code></a> to encode + and decode a storable property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/GenericStorableCodec.html#com.amazon.carbonado.raw">GenericStorableCodec</a> +<div class="block">Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/GenericStorableCodec.Decoder.html#com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a> +<div class="block">Used for decoding different generations of Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/GenericStorableCodec.SearchKeyFactory.html#com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a> +<div class="block">Creates custom raw search keys for <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/GenericStorableCodecFactory.html#com.amazon.carbonado.raw">GenericStorableCodecFactory</a> +<div class="block">Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/RawSupport.html#com.amazon.carbonado.raw">RawSupport</a> +<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> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/StorableCodec.html#com.amazon.carbonado.raw">StorableCodec</a> +<div class="block">Supports encoding and decoding of storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/StorableCodecFactory.html#com.amazon.carbonado.raw">StorableCodecFactory</a> +<div class="block">Factory for creating instances of <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodec</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/StorablePropertyInfo.html#com.amazon.carbonado.raw">StorablePropertyInfo</a> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> used by <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/raw/class-use/StorableCodecFactory.html#com.amazon.carbonado.repo.sleepycat">StorableCodecFactory</a> +<div class="block">Factory for creating instances of <a href="../../../../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodec</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/raw/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html new file mode 100644 index 0000000..53038eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html @@ -0,0 +1,226 @@ +<!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>IndexEntryAccessCapability (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="IndexEntryAccessCapability (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/IndexEntryAccessCapability.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/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.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/IndexEntryAccessCapability.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessCapability.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 IndexEntryAccessCapability" class="title">Interface IndexEntryAccessCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IndexEntryAccessCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.</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><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html#getIndexEntryAccessors(java.lang.Class)">getIndexEntryAccessors</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type.</div> +</td> +</tr> +</table> +</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="getIndexEntryAccessors(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getIndexEntryAccessors</h4> +<pre><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S>[] getIndexEntryAccessors(java.lang.Class<S> storableType) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type. The array might be empty, but it is never null. The array + is a copy, and so it may be safely modified.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/IndexEntryAccessCapability.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/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.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/IndexEntryAccessCapability.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html new file mode 100644 index 0000000..7a61df5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html @@ -0,0 +1,346 @@ +<!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>IndexEntryAccessor (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="IndexEntryAccessor (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/IndexEntryAccessor.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/IndexEntryAccessCapability.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/StoredIndexInfo.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/IndexEntryAccessor.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessor.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 IndexEntryAccessor" class="title">Interface IndexEntryAccessor<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/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IndexEntryAccessor<S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></pre> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</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/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><code>IndexEntryAccessCapability</code></a></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/repo/indexed/IndexEntryAccessor.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Sets all the properties of the given index entry, using the applicable + properties of the given master.</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/IndexEntryAccessor.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Comparator<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getComparator()">getComparator</a></strong>()</code> +<div class="block">Returns a comparator for ordering index entries.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getIndexEntryStorage()">getIndexEntryStorage</a></strong>()</code> +<div class="block">Returns the index entry storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master)</code> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.</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/IndexEntryAccessor.html#repair(double)">repair</a></strong>(double desiredSpeed)</code> +<div class="block">Repairs the index by inserting missing entries and fixing + inconsistencies.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.capability.IndexInfo"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></h3> +<code><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#getName()">getName</a>, <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections</a>, <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">getPropertyNames</a>, <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">isClustered</a>, <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">isUnique</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="getIndexEntryStorage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexEntryStorage</h4> +<pre><a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><?> getIndexEntryStorage()</pre> +<div class="block">Returns the index entry storage.</div> +</li> +</ul> +<a name="copyToMasterPrimaryKey(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyToMasterPrimaryKey</h4> +<pre>void copyToMasterPrimaryKey(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - source of property values</dd><dd><code>master</code> - master whose primary key properties will be set</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="copyFromMaster(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyFromMaster(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyFromMaster</h4> +<pre>void copyFromMaster(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Sets all the properties of the given index entry, using the applicable + properties of the given master.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - index entry whose properties will be set</dd><dd><code>master</code> - source of property values</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="isConsistent(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="isConsistent(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isConsistent</h4> +<pre>boolean isConsistent(<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> master) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, exluding any version property. This will always + return true after a call to copyFromMaster.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - index entry whose properties will be tested</dd><dd><code>master</code> - source of property values</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="repair(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>repair</h4> +<pre>void repair(double desiredSpeed) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Repairs the index by inserting missing entries and fixing + inconsistencies.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desiredSpeed</code> - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="getComparator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getComparator</h4> +<pre>java.util.Comparator<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getComparator()</pre> +<div class="block">Returns a comparator for ordering index entries.</div> +</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/IndexEntryAccessor.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/IndexEntryAccessCapability.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/StoredIndexInfo.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/IndexEntryAccessor.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessor.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html new file mode 100644 index 0000000..a18c2a3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html @@ -0,0 +1,616 @@ +<!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>IndexedRepositoryBuilder (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="IndexedRepositoryBuilder (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/IndexedRepositoryBuilder.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 Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.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/IndexedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="IndexedRepositoryBuilder.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><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.repo.indexed</div> +<h2 title="Class IndexedRepositoryBuilder" class="title">Class IndexedRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder</li> +</ul> +</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/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IndexedRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Repository builder for the indexed repository. + <p> + In addition to supporting the capabilities of the wrapped repository, the + following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>StorableInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><code>IndexEntryAccessCapability</code></a> + </ul></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"> +<!-- ======== 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/repo/indexed/IndexedRepositoryBuilder.html#IndexedRepositoryBuilder()">IndexedRepositoryBuilder</a></strong>()</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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository 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/IndexedRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle</a></strong>()</code> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.</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/IndexedRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getWrappedRepository()">getWrappedRepository</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isAllClustered()">isAllClustered</a></strong>()</code> +<div class="block">Returns true if all indexes should be identified as clustered.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setAllClustered(boolean)">setAllClustered</a></strong>(boolean clustered)</code> +<div class="block">When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well.</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/IndexedRepositoryBuilder.html#setIndexRepairDiscardDuplicates(boolean)">setIndexRepairDiscardDuplicates</a></strong>(boolean discardDuplicates)</code> +<div class="block">Set true to skip collisions during index repair, logging each as a + warning.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairEnabled(boolean)">setIndexRepairEnabled</a></strong>(boolean enabled)</code> +<div class="block">By default, index repair is enabled.</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/IndexedRepositoryBuilder.html#setIndexRepairThrottle(double)">setIndexRepairThrottle</a></strong>(double desiredSpeed)</code> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairVerifyOnly(boolean)">setIndexRepairVerifyOnly</a></strong>(boolean verifyOnly)</code> +<div class="block">Set true to build and verify indexes, but don't apply any changes.</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/IndexedRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</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/IndexedRepositoryBuilder.html#setStrictTriggers(boolean)">setStrictTriggers</a></strong>(boolean strict)</code> +<div class="block">Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setWrappedRepository(com.amazon.carbonado.RepositoryBuilder)">setWrappedRepository</a></strong>(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> repoBuilder)</code> +<div class="block">Set the required wrapped respository, which must support the + <a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li> +</ul> +<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> +</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="IndexedRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IndexedRepositoryBuilder</h4> +<pre>public IndexedRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean b)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="getWrappedRepository()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWrappedRepository</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> getWrappedRepository()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>wrapped respository</dd></dl> +</li> +</ul> +<a name="setWrappedRepository(com.amazon.carbonado.RepositoryBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWrappedRepository</h4> +<pre>public void setWrappedRepository(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> repoBuilder)</pre> +<div class="block">Set the required wrapped respository, which must support the + <a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>.</div> +</li> +</ul> +<a name="isIndexRepairEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexRepairEnabled</h4> +<pre>public boolean isIndexRepairEnabled()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true by default</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairEnabled(boolean)"><code>setIndexRepairEnabled(boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setIndexRepairEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairEnabled</h4> +<pre>public void setIndexRepairEnabled(boolean enabled)</pre> +<div class="block">By default, index repair is enabled. In this mode, the first time a + Storable type is used, new indexes are populated and old indexes are + removed. Until finished, access to the Storable is blocked. + + <p>When index repair is disabled, the Storable is immediately + available. This does have consequences, however. The set of indexes + available for queries is defined by the <i>intersection</i> of the old + and new index sets. The set of indexes that are kept up-to-date is + defined by the <i>union</i> of the old and new index sets. + + <p>While index repair is disabled, another process can safely repair the + indexes in the background. When it is complete, index repair can be + enabled for this repository too.</div> +</li> +</ul> +<a name="getIndexRepairThrottle()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexRepairThrottle</h4> +<pre>public double getIndexRepairThrottle()</pre> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired. By default this value is 1.0, or maximum speed.</div> +</li> +</ul> +<a name="setIndexRepairThrottle(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairThrottle</h4> +<pre>public void setIndexRepairThrottle(double desiredSpeed)</pre> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired. By default this value is 1.0, or maximum speed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desiredSpeed</code> - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work</dd></dl> +</li> +</ul> +<a name="setIndexRepairDiscardDuplicates(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairDiscardDuplicates</h4> +<pre>public void setIndexRepairDiscardDuplicates(boolean discardDuplicates)</pre> +<div class="block">Set true to skip collisions during index repair, logging each as a + warning.</div> +</li> +</ul> +<a name="setIndexRepairVerifyOnly(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairVerifyOnly</h4> +<pre>public void setIndexRepairVerifyOnly(boolean verifyOnly)</pre> +<div class="block">Set true to build and verify indexes, but don't apply any changes.</div> +</li> +</ul> +<a name="isAllClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAllClustered</h4> +<pre>public boolean isAllClustered()</pre> +<div class="block">Returns true if all indexes should be identified as clustered. This + affects how indexes are selected by the query analyzer.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setAllClustered(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAllClustered</h4> +<pre>public void setAllClustered(boolean clustered)</pre> +<div class="block">When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well. This is suitable for indexing + repositories that never read from a slow storage medium.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setStrictTriggers(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStrictTriggers</h4> +<pre>public void setStrictTriggers(boolean strict)</pre> +<div class="block">Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.</div> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/IndexedRepositoryBuilder.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 Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.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/IndexedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="IndexedRepositoryBuilder.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><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> 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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html b/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html new file mode 100644 index 0000000..1563e98 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/Unindexed.html @@ -0,0 +1,171 @@ +<!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>Unindexed (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="Unindexed (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/Unindexed.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/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/Unindexed.html" target="_top">Frames</a></li> +<li><a href="Unindexed.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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 Unindexed" class="title">Interface Unindexed</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Unindexed</span></pre> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</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/Unindexed.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/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/Unindexed.html" target="_top">Frames</a></li> +<li><a href="Unindexed.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html new file mode 100644 index 0000000..38e77db --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability (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="Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability (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><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability" class="title">Uses of Interface<br>com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.indexed.IndexEntryAccessCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessCapability.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html new file mode 100644 index 0000000..0349ef9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html @@ -0,0 +1,163 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor (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="Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor (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><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessor.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor" class="title">Uses of Interface<br>com.amazon.carbonado.repo.indexed.IndexEntryAccessor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a> in <a href="../../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> that return <a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S>[]</code></td> +<td class="colLast"><span class="strong">IndexEntryAccessCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html#getIndexEntryAccessors(java.lang.Class)">getIndexEntryAccessors</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html" target="_top">Frames</a></li> +<li><a href="IndexEntryAccessor.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html new file mode 100644 index 0000000..5ae0a01 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder (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="Uses of Class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder (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><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="IndexedRepositoryBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/IndexedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="IndexedRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html new file mode 100644 index 0000000..c9b990f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/StoredIndexInfo.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.indexed.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="Uses of Interface com.amazon.carbonado.repo.indexed.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><a href="../../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.indexed.StoredIndexInfo" class="title">Uses of Interface<br>com.amazon.carbonado.repo.indexed.StoredIndexInfo</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.indexed.StoredIndexInfo</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html b/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html new file mode 100644 index 0000000..cb241b5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/class-use/Unindexed.html @@ -0,0 +1,189 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.indexed.Unindexed (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="Uses of Interface com.amazon.carbonado.repo.indexed.Unindexed (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><a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/Unindexed.html" target="_top">Frames</a></li> +<li><a href="Unindexed.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.indexed.Unindexed" class="title">Uses of Interface<br>com.amazon.carbonado.repo.indexed.Unindexed</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a> in <a href="../../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a> in <a href="../../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></strong></code> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a> in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that implement <a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></strong></code> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/indexed/class-use/Unindexed.html" target="_top">Frames</a></li> +<li><a href="Unindexed.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html b/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html new file mode 100644 index 0000000..4bed9bf --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-frame.html @@ -0,0 +1,27 @@ +<!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.repo.indexed (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> +<h1 class="bar"><a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html" target="classFrame">com.amazon.carbonado.repo.indexed</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed" target="classFrame"><i>IndexEntryAccessCapability</i></a></li> +<li><a href="IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed" target="classFrame"><i>IndexEntryAccessor</i></a></li> +<li><a href="StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed" target="classFrame"><i>StoredIndexInfo</i></a></li> +<li><a href="Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed" target="classFrame"><i>Unindexed</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed" target="classFrame">IndexedRepositoryBuilder</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html b/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html new file mode 100644 index 0000000..07a36e4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-summary.html @@ -0,0 +1,187 @@ +<!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.repo.indexed (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.repo.indexed (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><a href="../../../../../com/amazon/carbonado/raw/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/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.repo.indexed</h1> +<div class="docSummary"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</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/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessCapability</a></td> +<td class="colLast"> +<div class="block">Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</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">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></td> +<td class="colLast"> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a></td> +<td class="colLast"> +<div class="block">Marker interface for storables that are not allowed to have indexes.</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/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Repository builder for the indexed repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.repo.indexed Description">Package com.amazon.carbonado.repo.indexed Description</h2> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support. The wrapped repository must support creation of + new types.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><code>IndexedRepositoryBuilder</code></a></dd></dl> +</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><a href="../../../../../com/amazon/carbonado/raw/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html b/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html new file mode 100644 index 0000000..0e00182 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-tree.html @@ -0,0 +1,162 @@ +<!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.repo.indexed Class Hierarchy (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.repo.indexed Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.repo.indexed</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>) +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><span class="strong">IndexedRepositoryBuilder</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">IndexEntryAccessCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfo</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">IndexEntryAccessor</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">StoredIndexInfo</span></a> (also extends com.amazon.carbonado.layout.<a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>, com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.layout.<a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Unevolvable</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">StoredIndexInfo</span></a> (also extends com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>, com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Unindexed</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">StoredIndexInfo</span></a> (also extends com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>, com.amazon.carbonado.layout.<a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>)</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/repo/indexed/package-use.html b/apidocs/com/amazon/carbonado/repo/indexed/package-use.html new file mode 100644 index 0000000..c6e3662 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/indexed/package-use.html @@ -0,0 +1,185 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.repo.indexed (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="Uses of Package com.amazon.carbonado.repo.indexed (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.repo.indexed" class="title">Uses of Package<br>com.amazon.carbonado.repo.indexed</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> used by <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/indexed/class-use/IndexEntryAccessor.html#com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/indexed/class-use/Unindexed.html#com.amazon.carbonado.repo.indexed">Unindexed</a> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> used by <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/indexed/class-use/Unindexed.html#com.amazon.carbonado.repo.sleepycat">Unindexed</a> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html new file mode 100644 index 0000000..7a08397 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html @@ -0,0 +1,215 @@ +<!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>JDBCBlobLoader (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="JDBCBlobLoader (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/JDBCBlobLoader.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 Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" target="_top">Frames</a></li> +<li><a href="JDBCBlobLoader.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.jdbc</div> +<h2 title="Interface JDBCBlobLoader" class="title">Interface JDBCBlobLoader</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">JDBCBlobLoader</span></pre> +<div class="block">Callback for reloading Blobs outside original transaction.</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>java.sql.Blob</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html#load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)">load</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> cap)</code> </td> +</tr> +</table> +</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="load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>load</h4> +<pre>java.sql.Blob load(<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> cap) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Blob or null if missing</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> +</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/JDBCBlobLoader.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 Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" target="_top">Frames</a></li> +<li><a href="JDBCBlobLoader.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html new file mode 100644 index 0000000..d8b97a8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html @@ -0,0 +1,215 @@ +<!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>JDBCClobLoader (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="JDBCClobLoader (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/JDBCClobLoader.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/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" target="_top">Frames</a></li> +<li><a href="JDBCClobLoader.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.jdbc</div> +<h2 title="Interface JDBCClobLoader" class="title">Interface JDBCClobLoader</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">JDBCClobLoader</span></pre> +<div class="block">Callback for reloading Clobs outside original transaction.</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>java.sql.Clob</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html#load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)">load</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> cap)</code> </td> +</tr> +</table> +</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="load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>load</h4> +<pre>java.sql.Clob load(<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> cap) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Clob or null if missing</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> +</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/JDBCClobLoader.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/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" target="_top">Frames</a></li> +<li><a href="JDBCClobLoader.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html new file mode 100644 index 0000000..9198bd4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html @@ -0,0 +1,370 @@ +<!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>JDBCConnectionCapability (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="JDBCConnectionCapability (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/JDBCConnectionCapability.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/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" target="_top">Frames</a></li> +<li><a href="JDBCConnectionCapability.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.jdbc</div> +<h2 title="Interface JDBCConnectionCapability" class="title">Interface JDBCConnectionCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">JDBCConnectionCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local. If no transaction is in progress, then + the connection is in auto-commit mode. + + <p>All connections retrieved from this capability must be properly + yielded. Do not close the connection directly, as this interferes with the + transaction's ability to properly manage it. + + <p>It is perfectly okay for other Carbonado calls to be made while the + connection is in use. Also, it is okay to request more connections, + although they will usually be the same instance. Failing to yield a + connection has an undefined behavior. + + <pre> + JDBCConnectionCapability cap = repo.getCapability(JDBCConnectionCapability.class); + Transaction txn = repo.enterTransaction(); + try { + Connection con = cap.getConnection(); + try { + ... + } finally { + cap.yieldConnection(con); + } + ... + txn.commit(); + } finally { + txn.exit(); + } + </pre></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>java.sql.Connection</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getConnection()">getConnection</a></strong>()</code> +<div class="block">Any connection returned by this method must be closed by calling + yieldConnection.</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/jdbc/JDBCConnectionCapability.html#getDatabaseProductName()">getDatabaseProductName</a></strong>()</code> +<div class="block">Returns the name of the database product connected to.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isTransactionForUpdate()">isTransactionForUpdate</a></strong>()</code> +<div class="block">Returns true if a transaction is in progress and it is for update.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isUniqueConstraintError(java.sql.SQLException)">isUniqueConstraintError</a></strong>(java.sql.SQLException e)</code> +<div class="block">Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toFetchException(java.lang.Throwable)">toFetchException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toPersistException(java.lang.Throwable)">toPersistException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#yieldConnection(java.sql.Connection)">yieldConnection</a></strong>(java.sql.Connection con)</code> +<div class="block">Gives up a connection returned from getConnection.</div> +</td> +</tr> +</table> +</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="getConnection()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnection</h4> +<pre>java.sql.Connection getConnection() + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Any connection returned by this method must be closed by calling + yieldConnection.</div> +<dl><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="yieldConnection(java.sql.Connection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>yieldConnection</h4> +<pre>void yieldConnection(java.sql.Connection con) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Gives up a connection returned from getConnection. Connection must be + yielded in same thread that retrieved it.</div> +<dl><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="toFetchException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toFetchException</h4> +<pre><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> toFetchException(java.lang.Throwable e)</pre> +<div class="block">Transforms the given throwable into an appropriate fetch exception. If + it already is a fetch exception, it is simply casted.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>FetchException, never null</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toPersistException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toPersistException</h4> +<pre><a href="../../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> toPersistException(java.lang.Throwable e)</pre> +<div class="block">Transforms the given throwable into an appropriate persist exception. If + it already is a persist exception, it is simply casted.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>PersistException, never null</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isUniqueConstraintError(java.sql.SQLException)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUniqueConstraintError</h4> +<pre>boolean isUniqueConstraintError(java.sql.SQLException e)</pre> +<div class="block">Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isTransactionForUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isTransactionForUpdate</h4> +<pre>boolean isTransactionForUpdate()</pre> +<div class="block">Returns true if a transaction is in progress and it is for update.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getDatabaseProductName()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDatabaseProductName</h4> +<pre>java.lang.String getDatabaseProductName()</pre> +<div class="block">Returns the name of the database product connected to.</div> +</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/JDBCConnectionCapability.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/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" target="_top">Frames</a></li> +<li><a href="JDBCConnectionCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html new file mode 100644 index 0000000..9f33066 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html @@ -0,0 +1,947 @@ +<!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>JDBCRepositoryBuilder (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="JDBCRepositoryBuilder (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/JDBCRepositoryBuilder.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/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="JDBCRepositoryBuilder.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><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.repo.jdbc</div> +<h2 title="Class JDBCRepositoryBuilder" class="title">Class JDBCRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder</li> +</ul> +</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/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">JDBCRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Builds a repository instance backed by a JDBC accessible database. + JDBCRepository is not independent of the underlying database schema, and so + it requires matching tables and columns in the database. It will not alter + or create tables. Use the <a href="../../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a> + annotation to control precisely which tables and columns must be matched up. + + <p>Note: The current JDBC repository implementation makes certain + assumptions about the database it is accessing. It must support transactions + and multiple statements per connection. If it doesn't support savepoints, + then nested transactions are faked -- rollback of inner transaction will + appear to do nothing. + + <p> + The following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>StorableInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><code>ShutdownCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><code>JDBCConnectionCapability</code></a> + </ul></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, bcastill, Adam D Bradley</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/repo/jdbc/JDBCRepositoryBuilder.html#JDBCRepositoryBuilder()">JDBCRepositoryBuilder</a></strong>()</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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository 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/jdbc/JDBCRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</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/jdbc/JDBCRepositoryBuilder.html#getCatalog()">getCatalog</a></strong>()</code> +<div class="block">Returns the optional catalog to search for metadata.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>javax.sql.DataSource</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSource()">getDataSource</a></strong>()</code> +<div class="block">Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSourceCloseOnShutdown()">getDataSourceCloseOnShutdown</a></strong>()</code> +<div class="block">Returns true if DataSource is closed when the repository is closed or + shutdown.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSourceLogging()">getDataSourceLogging</a></strong>()</code> +<div class="block">Returns true if debug logging is enabled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDefaultFetchSize()">getDefaultFetchSize</a></strong>()</code> +<div class="block">Returns the default fetch size when running queries, or null if driver + default is used instead.</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/jdbc/JDBCRepositoryBuilder.html#getDriverClassName()">getDriverClassName</a></strong>()</code> +<div class="block">Returns the driver class name, which may be null if a DataSource was provided.</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/jdbc/JDBCRepositoryBuilder.html#getDriverURL()">getDriverURL</a></strong>()</code> +<div class="block">Returns the connection URL, which may be null if a DataSource was + provided.</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/jdbc/JDBCRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</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/jdbc/JDBCRepositoryBuilder.html#getPassword()">getPassword</a></strong>()</code> +<div class="block">Returns the optional password to use with DataSource.</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/jdbc/JDBCRepositoryBuilder.html#getSchema()">getSchema</a></strong>()</code> +<div class="block">Returns the optional schema to search for metadata.</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/jdbc/JDBCRepositoryBuilder.html#getSequenceSelectStatement()">getSequenceSelectStatement</a></strong>()</code> +<div class="block">Returns the native sequence select statement, which is null if the + default is chosen.</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/jdbc/JDBCRepositoryBuilder.html#getUserName()">getUserName</a></strong>()</code> +<div class="block">Returns the optional username to use with DataSource.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#isForceStoredSequence()">isForceStoredSequence</a></strong>()</code> +<div class="block">Returns true if native sequences should not be used.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setAutoVersioningEnabled(boolean, java.lang.String)">setAutoVersioningEnabled</a></strong>(boolean enabled, + java.lang.String className)</code> +<div class="block">By default, JDBCRepository assumes that <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version numbers</code></a> are initialized and + incremented by triggers installed on the database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setCatalog(java.lang.String)">setCatalog</a></strong>(java.lang.String catalog)</code> +<div class="block">Optionally set the catalog to search for metadata.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSource(javax.sql.DataSource)">setDataSource</a></strong>(javax.sql.DataSource dataSource)</code> +<div class="block">Set the source of JDBC connections, overriding any configuration + supported by these methods: + + + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverClassName(java.lang.String)"><code>setDriverClassName(java.lang.String)</code></a> + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverURL(java.lang.String)"><code>setDriverURL(java.lang.String)</code></a> + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setUserName(java.lang.String)"><code>setUserName(java.lang.String)</code></a> + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPassword(java.lang.String)"><code>setPassword(java.lang.String)</code></a> + </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSourceCloseOnShutdown(boolean)">setDataSourceCloseOnShutdown</a></strong>(boolean b)</code> +<div class="block">Pass true to cause the DataSource to be closed when the repository is + closed or shutdown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSourceLogging(boolean)">setDataSourceLogging</a></strong>(boolean b)</code> +<div class="block">Pass true to enable debug logging.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDefaultFetchSize(java.lang.Integer)">setDefaultFetchSize</a></strong>(java.lang.Integer size)</code> +<div class="block">Set the default fetch size when running queries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverClassName(java.lang.String)">setDriverClassName</a></strong>(java.lang.String driverClassName)</code> +<div class="block">Set the JDBC driver class name, which is required if a DataSource was not provided.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverURL(java.lang.String)">setDriverURL</a></strong>(java.lang.String url)</code> +<div class="block">Set the JDBC connection URL, which is required if a DataSource was not + provided.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setForceStoredSequence(boolean)">setForceStoredSequence</a></strong>(boolean forceStoredSequence)</code> +<div class="block">By default, native sequences are used if supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPassword(java.lang.String)">setPassword</a></strong>(java.lang.String password)</code> +<div class="block">Optionally set the password to use with DataSource.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPrimaryKeyCheckDisabled(boolean)">setPrimaryKeyCheckDisabled</a></strong>(boolean primaryKeyCheckDisabled)</code> +<div class="block">By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSchema(java.lang.String)">setSchema</a></strong>(java.lang.String schema)</code> +<div class="block">Optionally set the schema to search for metadata.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSequenceSelectStatement(java.lang.String)">setSequenceSelectStatement</a></strong>(java.lang.String sequenceSelectStatement)</code> +<div class="block">Override the default native sequence select statement with a printf.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSuppressReload(boolean, java.lang.String)">setSuppressReload</a></strong>(boolean suppress, + java.lang.String className)</code> +<div class="block">By default, JDBCRepository reloads Storables after every insert or + update.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setUserName(java.lang.String)">setUserName</a></strong>(java.lang.String username)</code> +<div class="block">Optionally set the username to use with DataSource.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li> +</ul> +<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> +</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="JDBCRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JDBCRepositoryBuilder</h4> +<pre>public JDBCRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean b)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setDataSource(javax.sql.DataSource)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataSource</h4> +<pre>public void setDataSource(javax.sql.DataSource dataSource)</pre> +<div class="block">Set the source of JDBC connections, overriding any configuration + supported by these methods: + + <ul> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverClassName(java.lang.String)"><code>setDriverClassName(java.lang.String)</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverURL(java.lang.String)"><code>setDriverURL(java.lang.String)</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setUserName(java.lang.String)"><code>setUserName(java.lang.String)</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPassword(java.lang.String)"><code>setPassword(java.lang.String)</code></a> + </ul></div> +</li> +</ul> +<a name="getDataSource()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataSource</h4> +<pre>public javax.sql.DataSource getDataSource() + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block">Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if driver class wasn't found</dd></dl> +</li> +</ul> +<a name="setDataSourceCloseOnShutdown(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataSourceCloseOnShutdown</h4> +<pre>public void setDataSourceCloseOnShutdown(boolean b)</pre> +<div class="block">Pass true to cause the DataSource to be closed when the repository is + closed or shutdown. By default, this option is false.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getDataSourceCloseOnShutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataSourceCloseOnShutdown</h4> +<pre>public boolean getDataSourceCloseOnShutdown()</pre> +<div class="block">Returns true if DataSource is closed when the repository is closed or + shutdown. By default, this option is false.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setDataSourceLogging(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataSourceLogging</h4> +<pre>public void setDataSourceLogging(boolean b)</pre> +<div class="block">Pass true to enable debug logging. By default, it is false.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><code>LoggingDataSource</code></a></dd></dl> +</li> +</ul> +<a name="getDataSourceLogging()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataSourceLogging</h4> +<pre>public boolean getDataSourceLogging()</pre> +<div class="block">Returns true if debug logging is enabled.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><code>LoggingDataSource</code></a></dd></dl> +</li> +</ul> +<a name="setCatalog(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCatalog</h4> +<pre>public void setCatalog(java.lang.String catalog)</pre> +<div class="block">Optionally set the catalog to search for metadata.</div> +</li> +</ul> +<a name="getCatalog()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCatalog</h4> +<pre>public java.lang.String getCatalog()</pre> +<div class="block">Returns the optional catalog to search for metadata.</div> +</li> +</ul> +<a name="setSchema(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSchema</h4> +<pre>public void setSchema(java.lang.String schema)</pre> +<div class="block">Optionally set the schema to search for metadata.</div> +</li> +</ul> +<a name="getSchema()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSchema</h4> +<pre>public java.lang.String getSchema()</pre> +<div class="block">Returns the optional schema to search for metadata.</div> +</li> +</ul> +<a name="setDriverClassName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDriverClassName</h4> +<pre>public void setDriverClassName(java.lang.String driverClassName)</pre> +<div class="block">Set the JDBC driver class name, which is required if a DataSource was not provided.</div> +</li> +</ul> +<a name="getDriverClassName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDriverClassName</h4> +<pre>public java.lang.String getDriverClassName()</pre> +<div class="block">Returns the driver class name, which may be null if a DataSource was provided.</div> +</li> +</ul> +<a name="setDriverURL(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDriverURL</h4> +<pre>public void setDriverURL(java.lang.String url)</pre> +<div class="block">Set the JDBC connection URL, which is required if a DataSource was not + provided.</div> +</li> +</ul> +<a name="getDriverURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDriverURL</h4> +<pre>public java.lang.String getDriverURL()</pre> +<div class="block">Returns the connection URL, which may be null if a DataSource was + provided.</div> +</li> +</ul> +<a name="setUserName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUserName</h4> +<pre>public void setUserName(java.lang.String username)</pre> +<div class="block">Optionally set the username to use with DataSource.</div> +</li> +</ul> +<a name="getUserName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserName</h4> +<pre>public java.lang.String getUserName()</pre> +<div class="block">Returns the optional username to use with DataSource.</div> +</li> +</ul> +<a name="setPassword(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPassword</h4> +<pre>public void setPassword(java.lang.String password)</pre> +<div class="block">Optionally set the password to use with DataSource.</div> +</li> +</ul> +<a name="getPassword()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPassword</h4> +<pre>public java.lang.String getPassword()</pre> +<div class="block">Returns the optional password to use with DataSource.</div> +</li> +</ul> +<a name="setDefaultFetchSize(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultFetchSize</h4> +<pre>public void setDefaultFetchSize(java.lang.Integer size)</pre> +<div class="block">Set the default fetch size when running queries. Pass null to let driver + use its own default.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getDefaultFetchSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultFetchSize</h4> +<pre>public java.lang.Integer getDefaultFetchSize()</pre> +<div class="block">Returns the default fetch size when running queries, or null if driver + default is used instead.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setAutoVersioningEnabled(boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoVersioningEnabled</h4> +<pre>public void setAutoVersioningEnabled(boolean enabled, + java.lang.String className)</pre> +<div class="block">By default, JDBCRepository assumes that <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version numbers</code></a> are initialized and + incremented by triggers installed on the database. Enabling automatic + versioning here causes the JDBCRepository to manage these operations + itself.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enabled</code> - true to enable, false to disable</dd><dd><code>className</code> - name of Storable type to enable automatic version + management on; pass null to enable all</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setSuppressReload(boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSuppressReload</h4> +<pre>public void setSuppressReload(boolean suppress, + java.lang.String className)</pre> +<div class="block">By default, JDBCRepository reloads Storables after every insert or + update. This ensures that any applied defaults or triggered changes are + available to the Storable. If the database has no such defaults or + triggers, suppressing reload can improve performance. + + <p>Note: If Storable has a version property and auto versioning is not + enabled, or if the Storable has any automatic properties, the Storable + might still be reloaded.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>suppress</code> - true to suppress, false to unsuppress</dd><dd><code>className</code> - name of Storable type to suppress reload for; pass null + to suppress all</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.3</dd></dl> +</li> +</ul> +<a name="getSequenceSelectStatement()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSequenceSelectStatement</h4> +<pre>public java.lang.String getSequenceSelectStatement()</pre> +<div class="block">Returns the native sequence select statement, which is null if the + default is chosen.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setSequenceSelectStatement(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSequenceSelectStatement</h4> +<pre>public void setSequenceSelectStatement(java.lang.String sequenceSelectStatement)</pre> +<div class="block">Override the default native sequence select statement with a printf. + For example, "SELECT %s.NEXTVAL FROM DUAL".</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isForceStoredSequence()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isForceStoredSequence</h4> +<pre>public boolean isForceStoredSequence()</pre> +<div class="block">Returns true if native sequences should not be used.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setForceStoredSequence(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForceStoredSequence</h4> +<pre>public void setForceStoredSequence(boolean forceStoredSequence)</pre> +<div class="block">By default, native sequences are used if supported. Otherwise, a table + named "CARBONADO_SEQUENCE" or "CARBONADO_SEQUENCES" is used instead to + hold sequence values. When forced, the table is always used instead of + native sequences.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setPrimaryKeyCheckDisabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPrimaryKeyCheckDisabled</h4> +<pre>public void setPrimaryKeyCheckDisabled(boolean primaryKeyCheckDisabled)</pre> +<div class="block">By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey. This is not always the desired behavior; + for example, you may have a table which uses a bigint for its actual + primary key but uses another column with a unique index as the + "primary" key from the application's point of view. Setting this + value to true allows this check to fail gracefully instead of + throwing a <a href="../../../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado"><code>MismatchException</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/JDBCRepositoryBuilder.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/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="JDBCRepositoryBuilder.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><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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html new file mode 100644 index 0000000..39ad99c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html @@ -0,0 +1,423 @@ +<!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>JDBCStorableInfo (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="JDBCStorableInfo (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/JDBCStorableInfo.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/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableInfo.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.jdbc</div> +<h2 title="Interface JDBCStorableInfo" class="title">Interface JDBCStorableInfo<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/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">JDBCStorableInfo<S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S></pre> +<div class="block">Contains all the metadata describing a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as + needed by JDBCRepository. It extends the regular <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><code>StorableInfo</code></a> with + information gathered from the database.</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/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><code>JDBCStorableIntrospector</code></a></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>java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Returns all the storable properties in an unmodifiable map.</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/jdbc/JDBCStorableInfo.html#getCatalogName()">getCatalogName</a></strong>()</code> +<div class="block">Returns the optional catalog name for the Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getDataProperties()">getDataProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIdentityProperties()">getIdentityProperties</a></strong>()</code> +<div class="block">Returns auto-increment properties which are primary key members.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIndexInfo()">getIndexInfo</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key.</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/jdbc/JDBCStorableInfo.html#getQualifiedTableName()">getQualifiedTableName</a></strong>()</code> +<div class="block">Returns the qualified table name for the Storable or null if + unsupported.</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/jdbc/JDBCStorableInfo.html#getSchemaName()">getSchemaName</a></strong>()</code> +<div class="block">Returns the optional schema name for the Storable.</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/jdbc/JDBCStorableInfo.html#getTableName()">getTableName</a></strong>()</code> +<div class="block">Returns the table name for the Storable or null if unsupported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getVersionProperty()">getVersionProperty</a></strong>()</code> +<div class="block">Returns the designated version property, or null if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#isSupported()">isSupported</a></strong>()</code> +<div class="block">Returns false only if storable type is <a href="../../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> + and no matching table was found.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.info.StorableInfo"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.info.<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></h3> +<code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlias(int)">getAlias</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAliasCount()">getAliasCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAliases()">getAliases</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKey(int)">getAlternateKey</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeyCount()">getAlternateKeyCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeys()">getAlternateKeys</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getIndex(int)">getIndex</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getIndexCount()">getIndexCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getIndexes()">getIndexes</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getName()">getName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPartitionKey()">getPartitionKey</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKey()">getPrimaryKey</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getStorableType()">getStorableType</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#isAuthoritative()">isAuthoritative</a>, <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#isIndependent()">isIndependent</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="isSupported()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSupported</h4> +<pre>boolean isSupported()</pre> +<div class="block">Returns false only if storable type is <a href="../../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> + and no matching table was found.</div> +</li> +</ul> +<a name="getCatalogName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCatalogName</h4> +<pre>java.lang.String getCatalogName()</pre> +<div class="block">Returns the optional catalog name for the Storable. Some databases use a + catalog name to fully qualify the table name.</div> +</li> +</ul> +<a name="getSchemaName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSchemaName</h4> +<pre>java.lang.String getSchemaName()</pre> +<div class="block">Returns the optional schema name for the Storable. Some databases use a + schema name to fully qualify the table name.</div> +</li> +</ul> +<a name="getTableName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTableName</h4> +<pre>java.lang.String getTableName()</pre> +<div class="block">Returns the table name for the Storable or null if unsupported.</div> +</li> +</ul> +<a name="getQualifiedTableName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQualifiedTableName</h4> +<pre>java.lang.String getQualifiedTableName()</pre> +<div class="block">Returns the qualified table name for the Storable or null if + unsupported. Is used by SQL statements.</div> +</li> +</ul> +<a name="getIndexInfo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexInfo</h4> +<pre><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[] getIndexInfo()</pre> +</li> +</ul> +<a name="getAllProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllProperties</h4> +<pre>java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>> getAllProperties()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAllProperties()">StorableInfo</a></code></strong></div> +<div class="block">Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAllProperties()">getAllProperties</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getPrimaryKeyProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyProperties</h4> +<pre>java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>> getPrimaryKeyProperties()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKeyProperties()">StorableInfo</a></code></strong></div> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getDataProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataProperties</h4> +<pre>java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>> getDataProperties()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getDataProperties()">StorableInfo</a></code></strong></div> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. Primary keys and joins are + excluded. Properties are always ordered, case-sensitive, by name.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getDataProperties()">getDataProperties</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getIdentityProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdentityProperties</h4> +<pre>java.util.Map<java.lang.String,<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>> getIdentityProperties()</pre> +<div class="block">Returns auto-increment properties which are primary key members. The map + should almost always be empty or contain one property.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getVersionProperty()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getVersionProperty</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>> getVersionProperty()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getVersionProperty()">StorableInfo</a></code></strong></div> +<div class="block">Returns the designated version property, or null if none.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getVersionProperty()">getVersionProperty</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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/JDBCStorableInfo.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/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableInfo.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html new file mode 100644 index 0000000..6a25a05 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html @@ -0,0 +1,297 @@ +<!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>JDBCStorableIntrospector (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="JDBCStorableIntrospector (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/JDBCStorableIntrospector.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/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableIntrospector.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><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.repo.jdbc</div> +<h2 title="Class JDBCStorableIntrospector" class="title">Class JDBCStorableIntrospector</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">com.amazon.carbonado.info.StorableIntrospector</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">JDBCStorableIntrospector</span> +extends <a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></pre> +<div class="block">Provides additional metadata for a <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type needed by + JDBCRepository. The storable type must match to a table in an external + database. All examined data is cached, so repeat examinations are fast, + unless the examination failed.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Adam D Bradley, Tobias Holgers, Archit Shivaprakash, Matt Carlson</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/repo/jdbc/JDBCStorableIntrospector.html#JDBCStorableIntrospector()">JDBCStorableIntrospector</a></strong>()</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>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html#examine(java.lang.Class, javax.sql.DataSource, java.lang.String, java.lang.String)">examine</a></strong>(java.lang.Class<S> type, + javax.sql.DataSource ds, + java.lang.String catalog, + java.lang.String schema)</code> +<div class="block">Examines the given class and returns a JDBCStorableInfo describing it.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.info.StorableIntrospector"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.info.<a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></h3> +<code><a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)">examine</a>, <a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html#inferType(java.lang.Class)">inferType</a>, <a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html#main(java.lang.String[])">main</a></code></li> +</ul> +<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> +</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="JDBCStorableIntrospector()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JDBCStorableIntrospector</h4> +<pre>public JDBCStorableIntrospector()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="examine(java.lang.Class, javax.sql.DataSource, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>examine</h4> +<pre>public static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S> examine(java.lang.Class<S> type, + javax.sql.DataSource ds, + java.lang.String catalog, + java.lang.String schema) + throws java.sql.SQLException, + <a href="../../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Examines the given class and returns a JDBCStorableInfo describing it. A + MalformedTypeException is thrown for a variety of reasons if the given + class is not a well-defined Storable type or if it can't match up with + an entity in the external database.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Storable type to examine</dd><dd><code>ds</code> - source of JDBC connections to use for matching to a table</dd><dd><code>catalog</code> - optional catalog to search</dd><dd><code>schema</code> - optional schema to search</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if Storable type is not well-formed</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there was a problem in accessing the database</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</dd> +<dd><code>java.sql.SQLException</code></dd> +<dd><code><a href="../../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</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/JDBCStorableIntrospector.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/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableIntrospector.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><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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html new file mode 100644 index 0000000..d8b240a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html @@ -0,0 +1,554 @@ +<!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>JDBCStorableProperty (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="JDBCStorableProperty (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/JDBCStorableProperty.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/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableProperty.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.jdbc</div> +<h2 title="Interface JDBCStorableProperty" class="title">Interface JDBCStorableProperty<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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">JDBCStorableProperty<S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S></pre> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as needed by JDBCRepository.</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/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><code>JDBCStorableIntrospector</code></a></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><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getAppliedAdapter()">getAppliedAdapter</a></strong>()</code> +<div class="block">Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getCharOctetLength()">getCharOctetLength</a></strong>()</code> +<div class="block">Returns the maximum amount of bytes for property value.</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/jdbc/JDBCStorableProperty.html#getColumnName()">getColumnName</a></strong>()</code> +<div class="block">Returns the table column for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getColumnSize()">getColumnSize</a></strong>()</code> +<div class="block">The column size is either the maximum number of characters or the + numeric precision.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDataType()">getDataType</a></strong>()</code> +<div class="block">Returns the data type as defined by <code>Types</code>.</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/jdbc/JDBCStorableProperty.html#getDataTypeName()">getDataTypeName</a></strong>()</code> +<div class="block">Returns the data type name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDecimalDigits()">getDecimalDigits</a></strong>()</code> +<div class="block">Returns the amount of fractional decimal digits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getExternalJoinElements()">getExternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the external join elements in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getInternalJoinElements()">getInternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getOrdinalPosition()">getOrdinalPosition</a></strong>()</code> +<div class="block">Returns the one-based index of the column in the table.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getPreparedStatementSetMethod()">getPreparedStatementSetMethod</a></strong>()</code> +<div class="block">Returns the method to use to set this property (by index) into a + PreparedStatement.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getResultSetGetMethod()">getResultSetGetMethod</a></strong>()</code> +<div class="block">Returns the method to use to access this property (by index) from a + ResultSet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isAutoIncrement()">isAutoIncrement</a></strong>()</code> +<div class="block">Returns true if property is declared as @Automatic and column is + designated as auto-increment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isColumnNullable()">isColumnNullable</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isSelectable()">isSelectable</a></strong>()</code> +<div class="block">Returns true if property is both supported and not a join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isSupported()">isSupported</a></strong>()</code> +<div class="block">Returns false only if property is independent and no matching column was + found.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.info.StorableProperty"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.info.<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></h3> +<code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()">getAdapter</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAlias(int)">getAlias</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAliasCount()">getAliasCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAliases()">getAliases</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getBeanName()">getBeanName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraint(int)">getConstraint</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraintCount()">getConstraintCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraints()">getConstraints</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getCovariantTypes()">getCovariantTypes</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedFromProperties()">getDerivedFromProperties</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedToProperties()">getDerivedToProperties</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getEnclosingType()">getEnclosingType</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinedType()">getJoinedType</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinElementCount()">getJoinElementCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getName()">getName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getNumber()">getNumber</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getReadMethod()">getReadMethod</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getReadMethodName()">getReadMethodName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getSequenceName()">getSequenceName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getType()">getType</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getWriteMethod()">getWriteMethod</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getWriteMethodName()">getWriteMethodName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isAlternateKeyMember()">isAlternateKeyMember</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isAutomatic()">isAutomatic</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isDerived()">isDerived</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isIndependent()">isIndependent</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isJoin()">isJoin</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isNullable()">isNullable</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isOneToOneJoin()">isOneToOneJoin</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isPartitionKeyMember()">isPartitionKeyMember</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isQuery()">isQuery</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isVersion()">isVersion</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#shouldCopyDerived()">shouldCopyDerived</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#toString()">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.Appender"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.util.<a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></h3> +<code><a href="../../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</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="isSupported()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSupported</h4> +<pre>boolean isSupported()</pre> +<div class="block">Returns false only if property is independent and no matching column was + found.</div> +</li> +</ul> +<a name="isSelectable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSelectable</h4> +<pre>boolean isSelectable()</pre> +<div class="block">Returns true if property is both supported and not a join. Simply put, + it can appear in a select statement.</div> +</li> +</ul> +<a name="isAutoIncrement()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutoIncrement</h4> +<pre>boolean isAutoIncrement()</pre> +<div class="block">Returns true if property is declared as @Automatic and column is + designated as auto-increment.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getColumnName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnName</h4> +<pre>java.lang.String getColumnName()</pre> +<div class="block">Returns the table column for this property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getDataType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataType</h4> +<pre>java.lang.Integer getDataType()</pre> +<div class="block">Returns the data type as defined by <code>Types</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getDataTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataTypeName</h4> +<pre>java.lang.String getDataTypeName()</pre> +<div class="block">Returns the data type name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="isColumnNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isColumnNullable</h4> +<pre>boolean isColumnNullable()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if column is nullable</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getResultSetGetMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResultSetGetMethod</h4> +<pre>java.lang.reflect.Method getResultSetGetMethod()</pre> +<div class="block">Returns the method to use to access this property (by index) from a + ResultSet.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getPreparedStatementSetMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreparedStatementSetMethod</h4> +<pre>java.lang.reflect.Method getPreparedStatementSetMethod()</pre> +<div class="block">Returns the method to use to set this property (by index) into a + PreparedStatement.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getAppliedAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAppliedAdapter</h4> +<pre><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> getAppliedAdapter()</pre> +<div class="block">Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements. Is null if not needed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported or if adapter not needed.</dd></dl> +</li> +</ul> +<a name="getColumnSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnSize</h4> +<pre>java.lang.Integer getColumnSize()</pre> +<div class="block">The column size is either the maximum number of characters or the + numeric precision.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getDecimalDigits()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDecimalDigits</h4> +<pre>java.lang.Integer getDecimalDigits()</pre> +<div class="block">Returns the amount of fractional decimal digits.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getCharOctetLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCharOctetLength</h4> +<pre>java.lang.Integer getCharOctetLength()</pre> +<div class="block">Returns the maximum amount of bytes for property value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getOrdinalPosition()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdinalPosition</h4> +<pre>java.lang.Integer getOrdinalPosition()</pre> +<div class="block">Returns the one-based index of the column in the table.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getInternalJoinElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalJoinElement</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>> getInternalJoinElement(int index)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">StorableProperty</a></code></strong></div> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">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="getInternalJoinElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalJoinElements</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>>[] getInternalJoinElements()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">StorableProperty</a></code></strong></div> +<div class="block">Returns a new array with all the internal join elements in it.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">getInternalJoinElements</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">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="getExternalJoinElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExternalJoinElement</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?> getExternalJoinElement(int index)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">StorableProperty</a></code></strong></div> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">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="getExternalJoinElements()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getExternalJoinElements</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?>[] getExternalJoinElements()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">StorableProperty</a></code></strong></div> +<div class="block">Returns a new array with all the external join elements in it.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">getExternalJoinElements</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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/JDBCStorableProperty.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/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableProperty.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html new file mode 100644 index 0000000..d8acf12 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCSupport.html @@ -0,0 +1,348 @@ +<!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>JDBCSupport (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="JDBCSupport (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/JDBCSupport.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/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCSupport.html" target="_top">Frames</a></li> +<li><a href="JDBCSupport.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.jdbc</div> +<h2 title="Interface JDBCSupport" class="title">Interface JDBCSupport<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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>, <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a>, <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">JDBCSupport<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>, <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></pre> +<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><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/repo/jdbc/JDBCSupport.html#convertBlob(java.sql.Blob, com.amazon.carbonado.repo.jdbc.JDBCBlobLoader)">convertBlob</a></strong>(java.sql.Blob blob, + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a> loader)</code> </td> +</tr> +<tr class="rowColor"> +<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/repo/jdbc/JDBCSupport.html#convertClob(java.sql.Clob, com.amazon.carbonado.repo.jdbc.JDBCClobLoader)">convertClob</a></strong>(java.sql.Clob clob, + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a> loader)</code> </td> +</tr> +<tr class="altColor"> +<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/repo/jdbc/JDBCSupport.html#setBlobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +<tr class="rowColor"> +<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/repo/jdbc/JDBCSupport.html#setClobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateBlob(com.amazon.carbonado.lob.Blob, com.amazon.carbonado.lob.Blob)">updateBlob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> oldBlob, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> newBlob)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateClob(com.amazon.carbonado.lob.Clob, com.amazon.carbonado.lob.Clob)">updateClob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> oldClob, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> newClob)</code> </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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></h3> +<code><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getConnection()">getConnection</a>, <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getDatabaseProductName()">getDatabaseProductName</a>, <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isTransactionForUpdate()">isTransactionForUpdate</a>, <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isUniqueConstraintError(java.sql.SQLException)">isUniqueConstraintError</a>, <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toFetchException(java.lang.Throwable)">toFetchException</a>, <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toPersistException(java.lang.Throwable)">toPersistException</a>, <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#yieldConnection(java.sql.Connection)">yieldConnection</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="convertBlob(java.sql.Blob, com.amazon.carbonado.repo.jdbc.JDBCBlobLoader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertBlob</h4> +<pre><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> convertBlob(java.sql.Blob blob, + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a> loader) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>loader</code> - used to reload Blob outside original transaction</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="convertClob(java.sql.Clob, com.amazon.carbonado.repo.jdbc.JDBCClobLoader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertClob</h4> +<pre><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> convertClob(java.sql.Clob clob, + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a> loader) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>loader</code> - used to reload Clob outside original transaction</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="setBlobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Blob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobValue</h4> +<pre><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> setBlobValue(java.sql.PreparedStatement ps, + int column, + <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> +<dl><dt><span class="strong">Returns:</span></dt><dd>original blob if too large and post-insert update is required, null otherwise</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> - instead of FetchException since this code is + called during an insert operation</dd></dl> +</li> +</ul> +<a name="setClobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Clob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClobValue</h4> +<pre><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> setClobValue(java.sql.PreparedStatement ps, + int column, + <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> +<dl><dt><span class="strong">Returns:</span></dt><dd>original clob if too large and post-insert update is required, null otherwise</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> - instead of FetchException since this code is + called during an insert operation</dd></dl> +</li> +</ul> +<a name="updateBlob(com.amazon.carbonado.lob.Blob, com.amazon.carbonado.lob.Blob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>updateBlob</h4> +<pre>void updateBlob(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> oldBlob, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> newBlob) + throws <a href="../../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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></dd></dl> +</li> +</ul> +<a name="updateClob(com.amazon.carbonado.lob.Clob, com.amazon.carbonado.lob.Clob)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>updateClob</h4> +<pre>void updateClob(<a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> oldClob, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> newClob) + throws <a href="../../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<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></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/JDBCSupport.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/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCSupport.html" target="_top">Frames</a></li> +<li><a href="JDBCSupport.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html new file mode 100644 index 0000000..d9f8e69 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/LoggingDataSource.html @@ -0,0 +1,447 @@ +<!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>LoggingDataSource (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="LoggingDataSource (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/LoggingDataSource.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/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" target="_top">Frames</a></li> +<li><a href="LoggingDataSource.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.jdbc</div> +<h2 title="Class LoggingDataSource" class="title">Class LoggingDataSource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.jdbc.LoggingDataSource</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">LoggingDataSource</span> +extends java.lang.Object +implements javax.sql.DataSource</pre> +<div class="block">Wraps another DataSource such that all SQL statements are logged as debug.</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/repo/jdbc/LoggingDataSource.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static javax.sql.DataSource</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#create(javax.sql.DataSource)">create</a></strong>(javax.sql.DataSource ds)</code> +<div class="block">Wraps the given DataSource which logs to the default log.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static javax.sql.DataSource</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#create(javax.sql.DataSource, org.apache.commons.logging.Log)">create</a></strong>(javax.sql.DataSource ds, + org.apache.commons.logging.Log log)</code> +<div class="block">Wraps the given DataSource which logs to the given log.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Connection</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getConnection()">getConnection</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Connection</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getConnection(java.lang.String, java.lang.String)">getConnection</a></strong>(java.lang.String username, + java.lang.String password)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getLoginTimeout()">getLoginTimeout</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.PrintWriter</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getLogWriter()">getLogWriter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.logging.Logger</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getParentLogger()">getParentLogger</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#isWrapperFor(java.lang.Class)">isWrapperFor</a></strong>(java.lang.Class<?> iface)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#setLoginTimeout(int)">setLoginTimeout</a></strong>(int seconds)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#setLogWriter(java.io.PrintWriter)">setLogWriter</a></strong>(java.io.PrintWriter writer)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#unwrap(java.lang.Class)">unwrap</a></strong>(java.lang.Class<T> iface)</code> </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> +</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="create(javax.sql.DataSource)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static javax.sql.DataSource create(javax.sql.DataSource ds)</pre> +<div class="block">Wraps the given DataSource which logs to the default log. If debug + logging is disabled, the original DataSource is returned.</div> +</li> +</ul> +<a name="create(javax.sql.DataSource, org.apache.commons.logging.Log)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static javax.sql.DataSource create(javax.sql.DataSource ds, + org.apache.commons.logging.Log log)</pre> +<div class="block">Wraps the given DataSource which logs to the given log. If debug logging + is disabled, the original DataSource is returned.</div> +</li> +</ul> +<a name="getConnection()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnection</h4> +<pre>public java.sql.Connection getConnection() + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getConnection</code> in interface <code>javax.sql.DataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="getConnection(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnection</h4> +<pre>public java.sql.Connection getConnection(java.lang.String username, + java.lang.String password) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getConnection</code> in interface <code>javax.sql.DataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="getLogWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogWriter</h4> +<pre>public java.io.PrintWriter getLogWriter() + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getLogWriter</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="setLogWriter(java.io.PrintWriter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogWriter</h4> +<pre>public void setLogWriter(java.io.PrintWriter writer) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>setLogWriter</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="setLoginTimeout(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLoginTimeout</h4> +<pre>public void setLoginTimeout(int seconds) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>setLoginTimeout</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="getLoginTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoginTimeout</h4> +<pre>public int getLoginTimeout() + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getLoginTimeout</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="unwrap(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unwrap</h4> +<pre>public <T> T unwrap(java.lang.Class<T> iface) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>unwrap</code> in interface <code>java.sql.Wrapper</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isWrapperFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isWrapperFor</h4> +<pre>public boolean isWrapperFor(java.lang.Class<?> iface) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>isWrapperFor</code> in interface <code>java.sql.Wrapper</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getParentLogger()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getParentLogger</h4> +<pre>public java.util.logging.Logger getParentLogger() + throws java.sql.SQLFeatureNotSupportedException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getParentLogger</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLFeatureNotSupportedException</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/LoggingDataSource.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/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" target="_top">Frames</a></li> +<li><a href="LoggingDataSource.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html new file mode 100644 index 0000000..44d9458 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/SimpleDataSource.html @@ -0,0 +1,501 @@ +<!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>SimpleDataSource (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="SimpleDataSource (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/SimpleDataSource.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/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" target="_top">Frames</a></li> +<li><a href="SimpleDataSource.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><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.repo.jdbc</div> +<h2 title="Class SimpleDataSource" class="title">Class SimpleDataSource</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.jdbc.SimpleDataSource</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SimpleDataSource</span> +extends java.lang.Object +implements javax.sql.DataSource</pre> +<div class="block">SimpleDataSource does not implement any connection pooling.</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"> +<!-- ======== 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/repo/jdbc/SimpleDataSource.html#SimpleDataSource(java.lang.String, java.lang.String, java.util.Properties)">SimpleDataSource</a></strong>(java.lang.String driverClass, + java.lang.String driverURL, + java.util.Properties properties)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#SimpleDataSource(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">SimpleDataSource</a></strong>(java.lang.String driverClass, + java.lang.String driverURL, + java.lang.String username, + java.lang.String password)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#SimpleDataSource(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Properties)">SimpleDataSource</a></strong>(java.lang.String driverClass, + java.lang.String driverURL, + java.lang.String username, + java.lang.String password, + java.util.Properties properties)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Connection</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getConnection()">getConnection</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Connection</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getConnection(java.lang.String, java.lang.String)">getConnection</a></strong>(java.lang.String username, + java.lang.String password)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getLoginTimeout()">getLoginTimeout</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.PrintWriter</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getLogWriter()">getLogWriter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.logging.Logger</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getParentLogger()">getParentLogger</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#isWrapperFor(java.lang.Class)">isWrapperFor</a></strong>(java.lang.Class<?> iface)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#setLoginTimeout(int)">setLoginTimeout</a></strong>(int seconds)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#setLogWriter(java.io.PrintWriter)">setLogWriter</a></strong>(java.io.PrintWriter writer)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#unwrap(java.lang.Class)">unwrap</a></strong>(java.lang.Class<T> iface)</code> </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> +</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="SimpleDataSource(java.lang.String, java.lang.String, java.util.Properties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimpleDataSource</h4> +<pre>public SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.util.Properties properties) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>driverClass</code> - JDBC driver to load; can pass null if already loaded</dd><dd><code>driverURL</code> - JDBC driver URL</dd><dd><code>properties</code> - optional connection properties</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="SimpleDataSource(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimpleDataSource</h4> +<pre>public SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.lang.String username, + java.lang.String password) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>driverClass</code> - JDBC driver to load; can pass null if already loaded</dd><dd><code>driverURL</code> - JDBC driver URL</dd><dd><code>username</code> - optional username to connect with</dd><dd><code>password</code> - optional password to connect with</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="SimpleDataSource(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Properties)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleDataSource</h4> +<pre>public SimpleDataSource(java.lang.String driverClass, + java.lang.String driverURL, + java.lang.String username, + java.lang.String password, + java.util.Properties properties) + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>driverClass</code> - JDBC driver to load; can pass null if already loaded</dd><dd><code>driverURL</code> - JDBC driver URL</dd><dd><code>username</code> - optional username to connect with</dd><dd><code>password</code> - optional password to connect with</dd><dd><code>properties</code> - optional connection properties</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></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="getConnection()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnection</h4> +<pre>public java.sql.Connection getConnection() + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getConnection</code> in interface <code>javax.sql.DataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="getConnection(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnection</h4> +<pre>public java.sql.Connection getConnection(java.lang.String username, + java.lang.String password) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getConnection</code> in interface <code>javax.sql.DataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="getLogWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogWriter</h4> +<pre>public java.io.PrintWriter getLogWriter() + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getLogWriter</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="setLogWriter(java.io.PrintWriter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogWriter</h4> +<pre>public void setLogWriter(java.io.PrintWriter writer) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>setLogWriter</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="setLoginTimeout(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLoginTimeout</h4> +<pre>public void setLoginTimeout(int seconds) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>setLoginTimeout</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="getLoginTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoginTimeout</h4> +<pre>public int getLoginTimeout() + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getLoginTimeout</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.sql.SQLException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="unwrap(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unwrap</h4> +<pre>public <T> T unwrap(java.lang.Class<T> iface) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>unwrap</code> in interface <code>java.sql.Wrapper</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isWrapperFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isWrapperFor</h4> +<pre>public boolean isWrapperFor(java.lang.Class<?> iface) + throws java.sql.SQLException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>isWrapperFor</code> in interface <code>java.sql.Wrapper</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getParentLogger()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getParentLogger</h4> +<pre>public java.util.logging.Logger getParentLogger() + throws java.sql.SQLFeatureNotSupportedException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>getParentLogger</code> in interface <code>javax.sql.CommonDataSource</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.sql.SQLFeatureNotSupportedException</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/SimpleDataSource.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/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" target="_top">Frames</a></li> +<li><a href="SimpleDataSource.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><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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html new file mode 100644 index 0000000..66eb446 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCBlobLoader (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="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCBlobLoader (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html" target="_top">Frames</a></li> +<li><a href="JDBCBlobLoader.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCBlobLoader" class="title">Uses of Interface<br>com.amazon.carbonado.repo.jdbc.JDBCBlobLoader</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a> in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with parameters of type <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a></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> +<tbody> +<tr class="altColor"> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertBlob(java.sql.Blob, com.amazon.carbonado.repo.jdbc.JDBCBlobLoader)">convertBlob</a></strong>(java.sql.Blob blob, + <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a> loader)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html" target="_top">Frames</a></li> +<li><a href="JDBCBlobLoader.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html new file mode 100644 index 0000000..dfbc020 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCClobLoader (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="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCClobLoader (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html" target="_top">Frames</a></li> +<li><a href="JDBCClobLoader.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCClobLoader" class="title">Uses of Interface<br>com.amazon.carbonado.repo.jdbc.JDBCClobLoader</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a> in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with parameters of type <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a></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> +<tbody> +<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"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertClob(java.sql.Clob, com.amazon.carbonado.repo.jdbc.JDBCClobLoader)">convertClob</a></strong>(java.sql.Clob clob, + <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a> loader)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html" target="_top">Frames</a></li> +<li><a href="JDBCClobLoader.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html new file mode 100644 index 0000000..05be10c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html @@ -0,0 +1,177 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability (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="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html" target="_top">Frames</a></li> +<li><a href="JDBCConnectionCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability" class="title">Uses of Interface<br>com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S extends <a href="../../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with parameters of type <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Blob</code></td> +<td class="colLast"><span class="strong">JDBCBlobLoader.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html#load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)">load</a></strong>(<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> cap)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.sql.Clob</code></td> +<td class="colLast"><span class="strong">JDBCClobLoader.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html#load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)">load</a></strong>(<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> cap)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html" target="_top">Frames</a></li> +<li><a href="JDBCConnectionCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html new file mode 100644 index 0000000..52cd724 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder (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="Uses of Class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="JDBCRepositoryBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="JDBCRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html new file mode 100644 index 0000000..aa5420a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html @@ -0,0 +1,165 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo (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="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableInfo.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableInfo" class="title">Uses of Interface<br>com.amazon.carbonado.repo.jdbc.JDBCStorableInfo</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a> in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S></code></td> +<td class="colLast"><span class="strong">JDBCStorableIntrospector.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html#examine(java.lang.Class, javax.sql.DataSource, java.lang.String, java.lang.String)">examine</a></strong>(java.lang.Class<S> type, + javax.sql.DataSource ds, + java.lang.String catalog, + java.lang.String schema)</code> +<div class="block">Examines the given class and returns a JDBCStorableInfo describing it.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableInfo.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html new file mode 100644 index 0000000..e53b20e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector (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="Uses of Class com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableIntrospector.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector" class="title">Uses of Class<br>com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.jdbc.JDBCStorableIntrospector</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableIntrospector.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html new file mode 100644 index 0000000..a5f144e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html @@ -0,0 +1,203 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty (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="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableProperty.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCStorableProperty" class="title">Uses of Interface<br>com.amazon.carbonado.repo.jdbc.JDBCStorableProperty</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a> in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?></code></td> +<td class="colLast"><span class="strong">JDBCStorableProperty.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></strong>(int index)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?>[]</code></td> +<td class="colLast"><span class="strong">JDBCStorableProperty.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getExternalJoinElements()">getExternalJoinElements</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>></code></td> +<td class="colLast"><span class="strong">JDBCStorableProperty.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></strong>(int index)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>>[]</code></td> +<td class="colLast"><span class="strong">JDBCStorableProperty.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getInternalJoinElements()">getInternalJoinElements</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">JDBCStorableInfo.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getVersionProperty()">getVersionProperty</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return types with arguments of type <a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">JDBCStorableInfo.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getAllProperties()">getAllProperties</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">JDBCStorableInfo.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getDataProperties()">getDataProperties</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">JDBCStorableInfo.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIdentityProperties()">getIdentityProperties</a></strong>()</code> +<div class="block">Returns auto-increment properties which are primary key members.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">JDBCStorableInfo.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableProperty.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html new file mode 100644 index 0000000..c814a5c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCSupport (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="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCSupport (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html" target="_top">Frames</a></li> +<li><a href="JDBCSupport.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.jdbc.JDBCSupport" class="title">Uses of Interface<br>com.amazon.carbonado.repo.jdbc.JDBCSupport</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.jdbc.JDBCSupport</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/JDBCSupport.html" target="_top">Frames</a></li> +<li><a href="JDBCSupport.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html new file mode 100644 index 0000000..a3aca5b --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.jdbc.LoggingDataSource (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="Uses of Class com.amazon.carbonado.repo.jdbc.LoggingDataSource (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html" target="_top">Frames</a></li> +<li><a href="LoggingDataSource.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.jdbc.LoggingDataSource" class="title">Uses of Class<br>com.amazon.carbonado.repo.jdbc.LoggingDataSource</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.jdbc.LoggingDataSource</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/LoggingDataSource.html" target="_top">Frames</a></li> +<li><a href="LoggingDataSource.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html new file mode 100644 index 0000000..fec23d1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.jdbc.SimpleDataSource (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="Uses of Class com.amazon.carbonado.repo.jdbc.SimpleDataSource (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><a href="../../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html" target="_top">Frames</a></li> +<li><a href="SimpleDataSource.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.jdbc.SimpleDataSource" class="title">Uses of Class<br>com.amazon.carbonado.repo.jdbc.SimpleDataSource</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.jdbc.SimpleDataSource</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/jdbc/class-use/SimpleDataSource.html" target="_top">Frames</a></li> +<li><a href="SimpleDataSource.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-frame.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-frame.html new file mode 100644 index 0000000..bf1a213 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-frame.html @@ -0,0 +1,32 @@ +<!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.repo.jdbc (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> +<h1 class="bar"><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html" target="classFrame">com.amazon.carbonado.repo.jdbc</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc" target="classFrame"><i>JDBCBlobLoader</i></a></li> +<li><a href="JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc" target="classFrame"><i>JDBCClobLoader</i></a></li> +<li><a href="JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc" target="classFrame"><i>JDBCConnectionCapability</i></a></li> +<li><a href="JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc" target="classFrame"><i>JDBCStorableInfo</i></a></li> +<li><a href="JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc" target="classFrame"><i>JDBCStorableProperty</i></a></li> +<li><a href="JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc" target="classFrame"><i>JDBCSupport</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc" target="classFrame">JDBCRepositoryBuilder</a></li> +<li><a href="JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc" target="classFrame">JDBCStorableIntrospector</a></li> +<li><a href="LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc" target="classFrame">LoggingDataSource</a></li> +<li><a href="SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc" target="classFrame">SimpleDataSource</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-summary.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-summary.html new file mode 100644 index 0000000..0d3cc12 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-summary.html @@ -0,0 +1,218 @@ +<!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.repo.jdbc (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.repo.jdbc (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><a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/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.repo.jdbc</h1> +<div class="docSummary"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</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/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a></td> +<td class="colLast"> +<div class="block">Callback for reloading Blobs outside original transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a></td> +<td class="colLast"> +<div class="block">Callback for reloading Clobs outside original transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></td> +<td class="colLast"> +<div class="block">Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</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">Contains all the metadata describing a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as + needed by JDBCRepository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</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">Contains all the metadata describing a property of a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as needed by JDBCRepository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> </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/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Builds a repository instance backed by a JDBC accessible database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCStorableIntrospector</a></td> +<td class="colLast"> +<div class="block">Provides additional metadata for a <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type needed by + JDBCRepository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></td> +<td class="colLast"> +<div class="block">Wraps another DataSource such that all SQL statements are logged as debug.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></td> +<td class="colLast"> +<div class="block">SimpleDataSource does not implement any connection pooling.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.repo.jdbc Description">Package com.amazon.carbonado.repo.jdbc Description</h2> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC. JDBC repository is not independent of the underlying database schema, + and so it requires matching tables and columns in the database. It will not + alter or create tables. Use the <a href="../../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a> + annotation to control precisely which tables and columns must be matched up.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><code>JDBCRepositoryBuilder</code></a></dd></dl> +</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><a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html new file mode 100644 index 0000000..7348f68 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-tree.html @@ -0,0 +1,191 @@ +<!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.repo.jdbc Class Hierarchy (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.repo.jdbc Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.repo.jdbc</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>) +<ul> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCRepositoryBuilder</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">LoggingDataSource</span></a> (implements javax.sql.DataSource)</li> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">SimpleDataSource</span></a> (implements javax.sql.DataSource)</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">StorableIntrospector</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCStorableIntrospector</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Appender</span></a> +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableProperty</span></a><S> (also extends java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCStorableProperty</span></a><S></li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCConnectionCapability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCSupport</span></a><S> (also extends com.amazon.carbonado.gen.<a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a><S>)</li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCBlobLoader</span></a></li> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCClobLoader</span></a></li> +<li type="circle">java.io.Serializable +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableProperty</span></a><S> (also extends com.amazon.carbonado.util.<a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>) +<ul> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCStorableProperty</span></a><S></li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableInfo</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCStorableInfo</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">StorableSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">TriggerSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.gen.<a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">MasterSupport</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCSupport</span></a><S> (also extends com.amazon.carbonado.repo.jdbc.<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a>)</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/package-use.html b/apidocs/com/amazon/carbonado/repo/jdbc/package-use.html new file mode 100644 index 0000000..cae08e9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/package-use.html @@ -0,0 +1,177 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.repo.jdbc (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="Uses of Package com.amazon.carbonado.repo.jdbc (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.repo.jdbc" class="title">Uses of Package<br>com.amazon.carbonado.repo.jdbc</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> used by <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/jdbc/class-use/JDBCBlobLoader.html#com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a> +<div class="block">Callback for reloading Blobs outside original transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/jdbc/class-use/JDBCClobLoader.html#com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a> +<div class="block">Callback for reloading Clobs outside original transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/jdbc/class-use/JDBCConnectionCapability.html#com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a> +<div class="block">Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableInfo.html#com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a> +<div class="block">Contains all the metadata describing a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as + needed by JDBCRepository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/jdbc/class-use/JDBCStorableProperty.html#com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as needed by JDBCRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html b/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html new file mode 100644 index 0000000..fc37f49 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/CommonsLog.html @@ -0,0 +1,299 @@ +<!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>CommonsLog (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="CommonsLog (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/CommonsLog.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 Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/CommonsLog.html" target="_top">Frames</a></li> +<li><a href="CommonsLog.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><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.repo.logging</div> +<h2 title="Class CommonsLog" class="title">Class CommonsLog</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.logging.CommonsLog</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/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">CommonsLog</span> +extends java.lang.Object +implements <a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></pre> +<div class="block">Log implementation that uses Jakarta Commons Logging at debug level.</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"> +<!-- ======== 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/repo/logging/CommonsLog.html#CommonsLog(java.lang.Class)">CommonsLog</a></strong>(java.lang.Class clazz)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/CommonsLog.html#CommonsLog(org.apache.commons.logging.Log)">CommonsLog</a></strong>(org.apache.commons.logging.Log log)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/CommonsLog.html#isEnabled()">isEnabled</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/CommonsLog.html#write(java.lang.String)">write</a></strong>(java.lang.String message)</code> </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> +</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="CommonsLog(org.apache.commons.logging.Log)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CommonsLog</h4> +<pre>public CommonsLog(org.apache.commons.logging.Log log)</pre> +</li> +</ul> +<a name="CommonsLog(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CommonsLog</h4> +<pre>public CommonsLog(java.lang.Class clazz)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEnabled</h4> +<pre>public boolean isEnabled()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html#isEnabled()">isEnabled</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></code></dd> +</dl> +</li> +</ul> +<a name="write(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(java.lang.String message)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html#write(java.lang.String)">write</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</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/CommonsLog.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 Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/CommonsLog.html" target="_top">Frames</a></li> +<li><a href="CommonsLog.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><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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/Log.html b/apidocs/com/amazon/carbonado/repo/logging/Log.html new file mode 100644 index 0000000..7fd808e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/Log.html @@ -0,0 +1,228 @@ +<!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>Log (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="Log (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/Log.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/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/Log.html" target="_top">Frames</a></li> +<li><a href="Log.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.logging</div> +<h2 title="Interface Log" class="title">Interface Log</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">CommonsLog</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Log</span></pre> +<div class="block">Very simple Log interface.</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html#isEnabled()">isEnabled</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html#write(java.lang.String)">write</a></strong>(java.lang.String message)</code> </td> +</tr> +</table> +</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="isEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEnabled</h4> +<pre>boolean isEnabled()</pre> +</li> +</ul> +<a name="write(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>write</h4> +<pre>void write(java.lang.String message)</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/Log.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/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/Log.html" target="_top">Frames</a></li> +<li><a href="Log.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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html b/apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html new file mode 100644 index 0000000..ce9c79c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/LogAccessCapability.html @@ -0,0 +1,216 @@ +<!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>LogAccessCapability (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="LogAccessCapability (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/LogAccessCapability.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/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/LogAccessCapability.html" target="_top">Frames</a></li> +<li><a href="LogAccessCapability.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.logging</div> +<h2 title="Interface LogAccessCapability" class="title">Interface LogAccessCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">LogAccessCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Provides access to the Log.</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><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html#getLog()">getLog</a></strong>()</code> </td> +</tr> +</table> +</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="getLog()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLog</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a> getLog()</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/LogAccessCapability.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/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/LogAccessCapability.html" target="_top">Frames</a></li> +<li><a href="LogAccessCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html new file mode 100644 index 0000000..5532586 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html @@ -0,0 +1,484 @@ +<!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>LoggingRepositoryBuilder (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="LoggingRepositoryBuilder (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/LoggingRepositoryBuilder.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/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="LoggingRepositoryBuilder.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><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.repo.logging</div> +<h2 title="Class LoggingRepositoryBuilder" class="title">Class LoggingRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder</li> +</ul> +</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/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">LoggingRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Repository implementation which logs activity against it. By default, all + logged messages are at the debug level. + + <p> + The following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging"><code>LogAccessCapability</code></a> + </ul> + + Example: + + <pre> + LoggingRepositoryBuilder loggingBuilder = new LoggingRepositoryBuilder(); + loggingBuilder.setActualRepositoryBuilder(...); + Repository repo = loggingBuilder.build(); + </pre></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"> +<!-- ======== 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/repo/logging/LoggingRepositoryBuilder.html#LoggingRepositoryBuilder()">LoggingRepositoryBuilder</a></strong>()</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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository 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/logging/LoggingRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getActualRepositoryBuilder()">getActualRepositoryBuilder</a></strong>()</code> +<div class="block">Returns the Repository that all calls are wrapped to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getLog()">getLog</a></strong>()</code> +<div class="block">Return the Log to use.</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/logging/LoggingRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setActualRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setActualRepositoryBuilder</a></strong>(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder)</code> +<div class="block">Set the Repository to wrap all calls to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setLog(com.amazon.carbonado.repo.logging.Log)">setLog</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a> log)</code> +<div class="block">Set the Log to use.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean master)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li> +</ul> +<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> +</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="LoggingRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LoggingRepositoryBuilder</h4> +<pre>public LoggingRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean master)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setLog(com.amazon.carbonado.repo.logging.Log)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLog</h4> +<pre>public void setLog(<a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a> log)</pre> +<div class="block">Set the Log to use. If null, use default. Log must be enabled when build + is called, or else no logging is ever performed.</div> +</li> +</ul> +<a name="getLog()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLog</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a> getLog()</pre> +<div class="block">Return the Log to use. If null, use default.</div> +</li> +</ul> +<a name="setActualRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setActualRepositoryBuilder</h4> +<pre>public void setActualRepositoryBuilder(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder)</pre> +<div class="block">Set the Repository to wrap all calls to.</div> +</li> +</ul> +<a name="getActualRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActualRepositoryBuilder</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> getActualRepositoryBuilder()</pre> +<div class="block">Returns the Repository that all calls are wrapped to.</div> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/LoggingRepositoryBuilder.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/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="LoggingRepositoryBuilder.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><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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/CommonsLog.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/CommonsLog.html new file mode 100644 index 0000000..9b9bb3f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/CommonsLog.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.logging.CommonsLog (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="Uses of Class com.amazon.carbonado.repo.logging.CommonsLog (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><a href="../../../../../../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/logging/class-use/CommonsLog.html" target="_top">Frames</a></li> +<li><a href="CommonsLog.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.logging.CommonsLog" class="title">Uses of Class<br>com.amazon.carbonado.repo.logging.CommonsLog</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.logging.CommonsLog</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/logging/class-use/CommonsLog.html" target="_top">Frames</a></li> +<li><a href="CommonsLog.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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html new file mode 100644 index 0000000..a895db1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/Log.html @@ -0,0 +1,195 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.logging.Log (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="Uses of Interface com.amazon.carbonado.repo.logging.Log (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><a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/logging/class-use/Log.html" target="_top">Frames</a></li> +<li><a href="Log.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.logging.Log" class="title">Uses of Interface<br>com.amazon.carbonado.repo.logging.Log</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a> in <a href="../../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> that implement <a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">CommonsLog</a></strong></code> +<div class="block">Log implementation that uses Jakarta Commons Logging at debug level.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> that return <a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></code></td> +<td class="colLast"><span class="strong">LoggingRepositoryBuilder.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getLog()">getLog</a></strong>()</code> +<div class="block">Return the Log to use.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></code></td> +<td class="colLast"><span class="strong">LogAccessCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html#getLog()">getLog</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> with parameters of type <a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LoggingRepositoryBuilder.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setLog(com.amazon.carbonado.repo.logging.Log)">setLog</a></strong>(<a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a> log)</code> +<div class="block">Set the Log to use.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/logging/class-use/Log.html" target="_top">Frames</a></li> +<li><a href="Log.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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html new file mode 100644 index 0000000..febcf9a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.logging.LogAccessCapability (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="Uses of Interface com.amazon.carbonado.repo.logging.LogAccessCapability (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><a href="../../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html" target="_top">Frames</a></li> +<li><a href="LogAccessCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.logging.LogAccessCapability" class="title">Uses of Interface<br>com.amazon.carbonado.repo.logging.LogAccessCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.logging.LogAccessCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/logging/class-use/LogAccessCapability.html" target="_top">Frames</a></li> +<li><a href="LogAccessCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html new file mode 100644 index 0000000..818055b --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder (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="Uses of Class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder (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><a href="../../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="LoggingRepositoryBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.logging.LoggingRepositoryBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/logging/class-use/LoggingRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="LoggingRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/package-frame.html b/apidocs/com/amazon/carbonado/repo/logging/package-frame.html new file mode 100644 index 0000000..732c5d9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/package-frame.html @@ -0,0 +1,26 @@ +<!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.repo.logging (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> +<h1 class="bar"><a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html" target="classFrame">com.amazon.carbonado.repo.logging</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Log.html" title="interface in com.amazon.carbonado.repo.logging" target="classFrame"><i>Log</i></a></li> +<li><a href="LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging" target="classFrame"><i>LogAccessCapability</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="CommonsLog.html" title="class in com.amazon.carbonado.repo.logging" target="classFrame">CommonsLog</a></li> +<li><a href="LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging" target="classFrame">LoggingRepositoryBuilder</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/repo/logging/package-summary.html b/apidocs/com/amazon/carbonado/repo/logging/package-summary.html new file mode 100644 index 0000000..bbc8a11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/package-summary.html @@ -0,0 +1,177 @@ +<!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.repo.logging (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.repo.logging (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><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/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.repo.logging</h1> +<div class="docSummary"> +<div class="block">Repository implementation which logs activity against it.</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/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></td> +<td class="colLast"> +<div class="block">Very simple Log interface.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">LogAccessCapability</a></td> +<td class="colLast"> +<div class="block">Provides access to the Log.</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/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">CommonsLog</a></td> +<td class="colLast"> +<div class="block">Log implementation that uses Jakarta Commons Logging at debug level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.repo.logging Description">Package com.amazon.carbonado.repo.logging Description</h2> +<div class="block">Repository implementation which logs activity against it. By default, all + logged messages are at the debug level.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging"><code>LoggingRepositoryBuilder</code></a></dd></dl> +</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><a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/package-tree.html b/apidocs/com/amazon/carbonado/repo/logging/package-tree.html new file mode 100644 index 0000000..dd712a0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/package-tree.html @@ -0,0 +1,144 @@ +<!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.repo.logging Class Hierarchy (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.repo.logging Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/jdbc/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/map/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.repo.logging</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>) +<ul> +<li type="circle">com.amazon.carbonado.repo.logging.<a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging"><span class="strong">LoggingRepositoryBuilder</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.repo.logging.<a href="../../../../../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging"><span class="strong">CommonsLog</span></a> (implements com.amazon.carbonado.repo.logging.<a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.logging.<a href="../../../../../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">LogAccessCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.repo.logging.<a href="../../../../../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Log</span></a></li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/jdbc/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/map/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/repo/logging/package-use.html b/apidocs/com/amazon/carbonado/repo/logging/package-use.html new file mode 100644 index 0000000..570c33a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/logging/package-use.html @@ -0,0 +1,154 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.repo.logging (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="Uses of Package com.amazon.carbonado.repo.logging (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.repo.logging" class="title">Uses of Package<br>com.amazon.carbonado.repo.logging</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> used by <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/logging/class-use/Log.html#com.amazon.carbonado.repo.logging">Log</a> +<div class="block">Very simple Log interface.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/logging/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html new file mode 100644 index 0000000..8191fcb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/MapRepositoryBuilder.html @@ -0,0 +1,481 @@ +<!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>MapRepositoryBuilder (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="MapRepositoryBuilder (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/MapRepositoryBuilder.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 Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="MapRepositoryBuilder.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><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.repo.map</div> +<h2 title="Class MapRepositoryBuilder" class="title">Class MapRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.map.MapRepositoryBuilder</li> +</ul> +</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/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MapRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Volatile repository implementation backed by a concurrent map. Locks used by + repository are coarse, much like <i>table locks</i>. Loads and queries + acquire read locks, and modifications acquire write locks. Within + transactions, loads and queries always acquire upgradable locks, to reduce + the likelihood of deadlock. + + <p>This repository supports transactions, which also may be + nested. Supported isolation levels are read committed and serializable. Read + uncommitted is promoted to read committed, and repeatable read is promoted + to serializable. + + <p> + The following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><code>ShutdownCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceCapability</code></a> + </ul> + + <p>Note: This repository uses concurrent navigable map classes, which became + available in JDK1.6.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- ======== 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/repo/map/MapRepositoryBuilder.html#MapRepositoryBuilder()">MapRepositoryBuilder</a></strong>()</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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#getLockTimeout()">getLockTimeout</a></strong>()</code> +<div class="block">Returns the lock timeout.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.concurrent.TimeUnit</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#getLockTimeoutUnit()">getLockTimeoutUnit</a></strong>()</code> +<div class="block">Returns the lock timeout unit.</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/map/MapRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#newRepository()">newRepository</a></strong>()</code> +<div class="block">Convenience method to build a new MapRepository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#setLockTimeout(int, java.util.concurrent.TimeUnit)">setLockTimeout</a></strong>(int timeout, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Set the lock timeout.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#setLockTimeoutMillis(int)">setLockTimeoutMillis</a></strong>(int timeout)</code> +<div class="block">Set the lock timeout, in milliseconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li> +</ul> +<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> +</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="MapRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MapRepositoryBuilder</h4> +<pre>public MapRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="newRepository()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newRepository</h4> +<pre>public static <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> newRepository()</pre> +<div class="block">Convenience method to build a new MapRepository.</div> +</li> +</ul> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean b)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setLockTimeoutMillis(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockTimeoutMillis</h4> +<pre>public void setLockTimeoutMillis(int timeout)</pre> +<div class="block">Set the lock timeout, in milliseconds. Default value is 500 milliseconds.</div> +</li> +</ul> +<a name="setLockTimeout(int, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockTimeout</h4> +<pre>public void setLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit)</pre> +<div class="block">Set the lock timeout. Default value is 500 milliseconds.</div> +</li> +</ul> +<a name="getLockTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockTimeout</h4> +<pre>public int getLockTimeout()</pre> +<div class="block">Returns the lock timeout. Call getLockTimeoutUnit to get the unit.</div> +</li> +</ul> +<a name="getLockTimeoutUnit()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLockTimeoutUnit</h4> +<pre>public java.util.concurrent.TimeUnit getLockTimeoutUnit()</pre> +<div class="block">Returns the lock timeout unit. Call getLockTimeout to get the timeout.</div> +</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/MapRepositoryBuilder.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 Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="MapRepositoryBuilder.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><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> diff --git a/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html new file mode 100644 index 0000000..029556d --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.map.MapRepositoryBuilder (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="Uses of Class com.amazon.carbonado.repo.map.MapRepositoryBuilder (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><a href="../../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="MapRepositoryBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.map.MapRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.repo.map.MapRepositoryBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.map.MapRepositoryBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/map/class-use/MapRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="MapRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/repo/map/package-frame.html b/apidocs/com/amazon/carbonado/repo/map/package-frame.html new file mode 100644 index 0000000..2c3eda2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-frame.html @@ -0,0 +1,20 @@ +<!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.repo.map (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> +<h1 class="bar"><a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html" target="classFrame">com.amazon.carbonado.repo.map</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map" target="classFrame">MapRepositoryBuilder</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/repo/map/package-summary.html b/apidocs/com/amazon/carbonado/repo/map/package-summary.html new file mode 100644 index 0000000..d4d670e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-summary.html @@ -0,0 +1,147 @@ +<!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.repo.map (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.repo.map (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><a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/map/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.repo.map</h1> +<div class="docSummary"> +<div class="block">Volatile repository implementation backed by a concurrent map.</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="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/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.repo.map Description">Package com.amazon.carbonado.repo.map Description</h2> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map"><code>MapRepositoryBuilder</code></a></dd></dl> +</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><a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/map/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> diff --git a/apidocs/com/amazon/carbonado/repo/map/package-tree.html b/apidocs/com/amazon/carbonado/repo/map/package-tree.html new file mode 100644 index 0000000..994619c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-tree.html @@ -0,0 +1,134 @@ +<!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.repo.map Class Hierarchy (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.repo.map Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/logging/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/replicated/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/map/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.repo.map</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>) +<ul> +<li type="circle">com.amazon.carbonado.repo.map.<a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map"><span class="strong">MapRepositoryBuilder</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/logging/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/replicated/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/map/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/repo/map/package-use.html b/apidocs/com/amazon/carbonado/repo/map/package-use.html new file mode 100644 index 0000000..a868c87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/map/package-use.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.repo.map (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="Uses of Package com.amazon.carbonado.repo.map (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/map/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.repo.map" class="title">Uses of Package<br>com.amazon.carbonado.repo.map</h1> +</div> +<div class="contentContainer">No usage of com.amazon.carbonado.repo.map</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/map/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html new file mode 100644 index 0000000..15c406c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html @@ -0,0 +1,473 @@ +<!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>ReplicatedRepositoryBuilder (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="ReplicatedRepositoryBuilder (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/ReplicatedRepositoryBuilder.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 Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="ReplicatedRepositoryBuilder.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><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.repo.replicated</div> +<h2 title="Class ReplicatedRepositoryBuilder" class="title">Class ReplicatedRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder</li> +</ul> +</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/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ReplicatedRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Repository builder for the replicated repository. + <p> + The following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><code>ResyncCapability</code></a> + </ul></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/repo/replicated/ReplicatedRepositoryBuilder.html#ReplicatedRepositoryBuilder()">ReplicatedRepositoryBuilder</a></strong>()</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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository 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/replicated/ReplicatedRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getMasterRepositoryBuilder()">getMasterRepositoryBuilder</a></strong>()</code> </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/replicated/ReplicatedRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getReplicaRepositoryBuilder()">getReplicaRepositoryBuilder</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setMasterRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setMasterRepositoryBuilder</a></strong>(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> masterRepositoryBuilder)</code> +<div class="block">Set "master" respository to replicate from, which is required.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setReplicaRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setReplicaRepositoryBuilder</a></strong>(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> replicaRepositoryBuilder)</code> +<div class="block">Set "replica" respository to replicate to, which is required.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li> +</ul> +<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> +</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="ReplicatedRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ReplicatedRepositoryBuilder</h4> +<pre>public ReplicatedRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean b)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="getReplicaRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicaRepositoryBuilder</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> getReplicaRepositoryBuilder()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>"replica" respository to replicate to.</dd></dl> +</li> +</ul> +<a name="setReplicaRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReplicaRepositoryBuilder</h4> +<pre>public void setReplicaRepositoryBuilder(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> replicaRepositoryBuilder)</pre> +<div class="block">Set "replica" respository to replicate to, which is required. This builder + automatically sets the master option of the given repository builder to + false.</div> +</li> +</ul> +<a name="getMasterRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMasterRepositoryBuilder</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> getMasterRepositoryBuilder()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>"master" respository to replicate from.</dd></dl> +</li> +</ul> +<a name="setMasterRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMasterRepositoryBuilder</h4> +<pre>public void setMasterRepositoryBuilder(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> masterRepositoryBuilder)</pre> +<div class="block">Set "master" respository to replicate from, which is required. This + builder automatically sets the master option of the given repository to + true.</div> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/ReplicatedRepositoryBuilder.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 Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="ReplicatedRepositoryBuilder.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><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> diff --git a/apidocs/com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html new file mode 100644 index 0000000..f321a4d --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder (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="Uses of Class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder (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><a href="../../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="ReplicatedRepositoryBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/replicated/class-use/ReplicatedRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="ReplicatedRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-frame.html b/apidocs/com/amazon/carbonado/repo/replicated/package-frame.html new file mode 100644 index 0000000..c83cb1c --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-frame.html @@ -0,0 +1,20 @@ +<!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.repo.replicated (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> +<h1 class="bar"><a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html" target="classFrame">com.amazon.carbonado.repo.replicated</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated" target="classFrame">ReplicatedRepositoryBuilder</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html b/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html new file mode 100644 index 0000000..3516d8b --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-summary.html @@ -0,0 +1,151 @@ +<!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.repo.replicated (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.repo.replicated (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><a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/replicated/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.repo.replicated</h1> +<div class="docSummary"> +<div class="block">Repository implementation that supports replication between two + repositories.</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="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/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Repository builder for the replicated repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.repo.replicated Description">Package com.amazon.carbonado.repo.replicated Description</h2> +<div class="block">Repository implementation that supports replication between two + repositories. One repository is the replica, and the other is the + master. Read operations are served by the replica, and the master is + consulted when writing. Changes to the master are copied to the replica.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</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><a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/replicated/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> diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-tree.html b/apidocs/com/amazon/carbonado/repo/replicated/package-tree.html new file mode 100644 index 0000000..ac2af7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-tree.html @@ -0,0 +1,134 @@ +<!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.repo.replicated Class Hierarchy (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.repo.replicated Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/map/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/replicated/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.repo.replicated</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>) +<ul> +<li type="circle">com.amazon.carbonado.repo.replicated.<a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><span class="strong">ReplicatedRepositoryBuilder</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/map/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/replicated/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/repo/replicated/package-use.html b/apidocs/com/amazon/carbonado/repo/replicated/package-use.html new file mode 100644 index 0000000..3f38ced --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/replicated/package-use.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.repo.replicated (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="Uses of Package com.amazon.carbonado.repo.replicated (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/replicated/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.repo.replicated" class="title">Uses of Package<br>com.amazon.carbonado.repo.replicated</h1> +</div> +<div class="contentContainer">No usage of com.amazon.carbonado.repo.replicated</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/replicated/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html new file mode 100644 index 0000000..bd9736e --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html @@ -0,0 +1,217 @@ +<!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>BDBPanicHandler (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="BDBPanicHandler (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/BDBPanicHandler.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 Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" target="_top">Frames</a></li> +<li><a href="BDBPanicHandler.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.sleepycat</div> +<h2 title="Interface BDBPanicHandler" class="title">Interface BDBPanicHandler</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">BDBPanicHandler</span></pre> +<div class="block">Interface for a generic panic handler for any BDB products.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Jesse Morgan</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/repo/sleepycat/BDBPanicHandler.html#onPanic(java.lang.Object, java.lang.Exception)">onPanic</a></strong>(java.lang.Object environment, + java.lang.Exception exception)</code> +<div class="block">Called when an Environment panics or an EnvironmentFailureException is thrown.</div> +</td> +</tr> +</table> +</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="onPanic(java.lang.Object, java.lang.Exception)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onPanic</h4> +<pre>void onPanic(java.lang.Object environment, + java.lang.Exception exception)</pre> +<div class="block">Called when an Environment panics or an EnvironmentFailureException is thrown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>environment</code> - The affected environment or null if the environment could not be opened.</dd><dd><code>exception</code> - The related exception.</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/BDBPanicHandler.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 Class</li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" target="_top">Frames</a></li> +<li><a href="BDBPanicHandler.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html new file mode 100644 index 0000000..a452514 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBProduct.html @@ -0,0 +1,392 @@ +<!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>BDBProduct (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="BDBProduct (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/BDBProduct.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/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBProduct.html" target="_top">Frames</a></li> +<li><a href="BDBProduct.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.sleepycat</div> +<h2 title="Enum BDBProduct" class="title">Enum BDBProduct</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.sleepycat.BDBProduct</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">BDBProduct</span> +extends java.lang.Enum<<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a>></pre> +<div class="block">Set of supported BDB products.</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"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#DB">DB</a></strong></code> +<div class="block">BDB Native</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#DB_HA">DB_HA</a></strong></code> +<div class="block">BDB Native, High Availability</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#DB_Legacy">DB_Legacy</a></strong></code> +<div class="block">BDB Native, legacy API</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#DBX">DBX</a></strong></code> +<div class="block">BDB Native, with reduced concurrency to eliminate deadlocks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#JE">JE</a></strong></code> +<div class="block">BDB Java Edition</div> +</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>static <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#forString(java.lang.String)">forString</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="DB_Legacy"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DB_Legacy</h4> +<pre>public static final <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> DB_Legacy</pre> +<div class="block">BDB Native, legacy API</div> +</li> +</ul> +<a name="DB"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DB</h4> +<pre>public static final <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> DB</pre> +<div class="block">BDB Native</div> +</li> +</ul> +<a name="DBX"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DBX</h4> +<pre>public static final <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> DBX</pre> +<div class="block">BDB Native, with reduced concurrency to eliminate deadlocks. Exclusive + lock is held when modifications are made, and at most one open + transaction is allowed at any given time.</div> +</li> +</ul> +<a name="DB_HA"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DB_HA</h4> +<pre>public static final <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> DB_HA</pre> +<div class="block">BDB Native, High Availability</div> +</li> +</ul> +<a name="JE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JE</h4> +<pre>public static final <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> JE</pre> +<div class="block">BDB Java Edition</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (BDBProduct c : BDBProduct.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="forString(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>forString</h4> +<pre>public static <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> forString(java.lang.String name)</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/BDBProduct.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/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBProduct.html" target="_top">Frames</a></li> +<li><a href="BDBProduct.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html new file mode 100644 index 0000000..90bc0eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html @@ -0,0 +1,237 @@ +<!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>BDBRepositoryBuilder.DatabaseHook (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="BDBRepositoryBuilder.DatabaseHook (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/BDBRepositoryBuilder.DatabaseHook.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/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.DatabaseHook.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.sleepycat</div> +<h2 title="Interface BDBRepositoryBuilder.DatabaseHook" class="title">Interface BDBRepositoryBuilder.DatabaseHook</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">BDBRepositoryBuilder.DatabaseHook</span></pre> +</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html#databaseName(java.lang.String)">databaseName</a></strong>(java.lang.String typeName)</code> +<div class="block">Returns an appropriate database name for the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html#prepareForOpening(java.lang.Object)">prepareForOpening</a></strong>(java.lang.Object db)</code> +<div class="block">Called right before database is opened.</div> +</td> +</tr> +</table> +</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="databaseName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>databaseName</h4> +<pre>java.lang.String databaseName(java.lang.String typeName)</pre> +<div class="block">Returns an appropriate database name for the given type. Simply + return the type name as-is to support default behavior.</div> +</li> +</ul> +<a name="prepareForOpening(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>prepareForOpening</h4> +<pre>void prepareForOpening(java.lang.Object db) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Called right before database is opened.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>db</code> - reference to database or config - actual type depends on BDB + implementation.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/BDBRepositoryBuilder.DatabaseHook.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/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.DatabaseHook.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html new file mode 100644 index 0000000..425a599 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html @@ -0,0 +1,2121 @@ +<!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>BDBRepositoryBuilder (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="BDBRepositoryBuilder (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/BDBRepositoryBuilder.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/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.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.repo.sleepycat</div> +<h2 title="Class BDBRepositoryBuilder" class="title">Class BDBRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder</li> +</ul> +</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/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="strong">BDBRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Builder and configuration options for BDBRepository. + + <pre> + BDBRepositoryBuilder builder = new BDBRepositoryBuilder(); + + builder.setProduct("JE"); + builder.setName("test"); + builder.setEnvironmentHome("/tmp/testRepo"); + builder.setTransactionWriteNoSync(true); + + Repository repo = builder.build(); + </pre> + + <p> + The following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>StorableInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><code>ShutdownCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><code>LayoutCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><code>CheckpointCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><code>EnvironmentCapability</code></a> + </ul></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Vidya Iyer, Nicole Deflaux</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/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</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/repo/sleepycat/BDBRepositoryBuilder.html#BDBRepositoryBuilder()">BDBRepositoryBuilder</a></strong>()</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/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository 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/sleepycat/BDBRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getBDBProduct()">getBDBProduct</a></strong>()</code> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCachePercent()">getCachePercent</a></strong>()</code> +<div class="block">Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCacheSize()">getCacheSize</a></strong>()</code> +<div class="block">Returns the repository cache size, or null if default should be + selected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointInterval()">getCheckpointInterval</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointThresholdKB()">getCheckpointThresholdKB</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointThresholdMinutes()">getCheckpointThresholdMinutes</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getChecksumEnabled()">getChecksumEnabled</a></strong>()</code> +<div class="block">Returns true if checksum verification is enabled.</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/sleepycat/BDBRepositoryBuilder.html#getCompressor(java.lang.String)">getCompressor</a></strong>(java.lang.String type)</code> +<div class="block">Return the compressor used for the given storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabaseHook()">getDatabaseHook</a></strong>()</code> +<div class="block">Returns the custom open database hook, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabasesTransactional()">getDatabasesTransactional</a></strong>()</code> +<div class="block">Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set</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/sleepycat/BDBRepositoryBuilder.html#getDataHome()">getDataHome</a></strong>()</code> +<div class="block">Returns the directory to store data files.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDataHomeFile()">getDataHomeFile</a></strong>()</code> +<div class="block">Returns the optional directory to store data files.</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/sleepycat/BDBRepositoryBuilder.html#getEnvironmentHome()">getEnvironmentHome</a></strong>()</code> +<div class="block">Returns the repository environment home directory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getEnvironmentHomeFile()">getEnvironmentHomeFile</a></strong>()</code> +<div class="block">Returns the repository environment home directory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle</a></strong>()</code> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getIndexSupport()">getIndexSupport</a></strong>()</code> +<div class="block">Returns true if indexes are supported, which is true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitialDatabaseConfig()">getInitialDatabaseConfig</a></strong>()</code> +<div class="block">Returns the optional BDB specific database configuration to use + for all databases created.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitialEnvironmentConfig()">getInitialEnvironmentConfig</a></strong>()</code> +<div class="block">Returns the optional BDB specific environment configuration to use.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitializeLogging()">getInitializeLogging</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getKeepOldLogFiles()">getKeepOldLogFiles</a></strong>()</code> +<div class="block">Returns false by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockConflictDeadlockDetectMode()">getLockConflictDeadlockDetectMode</a></strong>()</code> +<div class="block">Returns true if deadlock detection is run whenever a lock conflict occurs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockTimeout()">getLockTimeout</a></strong>()</code> +<div class="block">Returns the lock timeout, in seconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockTimeoutInMicroseconds()">getLockTimeoutInMicroseconds</a></strong>()</code> +<div class="block">Returns the lock timeout, in microseconds, limited to max long value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogFileMaxSize()">getLogFileMaxSize</a></strong>()</code> +<div class="block">Returns null if default size will be used.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogInMemory()">getLogInMemory</a></strong>()</code> +<div class="block">Returns false by default, indicating that transaction logs are persisted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogRegionSize()">getLogRegionSize</a></strong>()</code> +<div class="block">Returns the repository log region size, or null if the default + should be selected.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getMaxLocks()">getMaxLocks</a></strong>()</code> </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/sleepycat/BDBRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPanicHandler()">getPanicHandler</a></strong>()</code> +<div class="block">Return the panic handler to call if the database panics.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Runnable</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPreShutdownHook()">getPreShutdownHook</a></strong>()</code> +<div class="block">Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.</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/sleepycat/BDBRepositoryBuilder.html#getProduct()">getProduct</a></strong>()</code> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getReadOnly()">getReadOnly</a></strong>()</code> +<div class="block">Returns true if repository should be opened read-only.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunCheckpointer()">getRunCheckpointer</a></strong>()</code> +<div class="block">Returns true if checkpointer is run automatically.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunDeadlockDetector()">getRunDeadlockDetector</a></strong>()</code> +<div class="block">Returns true if deadlock detector is configured to run.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunFullRecovery()">getRunFullRecovery</a></strong>()</code> +<div class="block">Returns true if a full (catastrophic) recovery should be performed when + environment is opened.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Runnable</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getShutdownHook()">getShutdownHook</a></strong>()</code> +<div class="block">Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.</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/sleepycat/BDBRepositoryBuilder.html#getSingleFileName()">getSingleFileName</a></strong>()</code> +<div class="block">Returns the single file that all BDB databases should reside in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getStorableCodecFactory()">getStorableCodecFactory</a></strong>()</code> +<div class="block">Returns the storable codec factory used.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionMaxActive()">getTransactionMaxActive</a></strong>()</code> +<div class="block">Returns the maximum number of concurrent transactions, or null if the + default is used.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionNoSync()">getTransactionNoSync</a></strong>()</code> +<div class="block">Returns true if transactions are not written or flushed to disk.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionTimeout()">getTransactionTimeout</a></strong>()</code> +<div class="block">Returns the repository transaction timeout, in seconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionTimeoutInMicroseconds()">getTransactionTimeoutInMicroseconds</a></strong>()</code> +<div class="block">Returns the repository transaction timeout, in microseconds, limited to + max long value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionWriteNoSync()">getTransactionWriteNoSync</a></strong>()</code> +<div class="block">Returns true if transactions are not flushed to disk.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isMultiversion()">isMultiversion</a></strong>()</code> +<div class="block">Returns false by default because multiversion concurrency control (MVCC) + is not enabled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isPrivate()">isPrivate</a></strong>()</code> +<div class="block">Returns true if BDB environment is private.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isReverseSplitOff()">isReverseSplitOff</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setBDBProduct(com.amazon.carbonado.repo.sleepycat.BDBProduct)">setBDBProduct</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> product)</code> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCachePercent(int)">setCachePercent</a></strong>(int cachePercent)</code> +<div class="block">Set the percent of JVM heap used by the repository cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCachePercent(java.lang.Integer)">setCachePercent</a></strong>(java.lang.Integer cachePercent)</code> +<div class="block">Set the percent of JVM heap used by the repository cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCacheSize(long)">setCacheSize</a></strong>(long cacheSize)</code> +<div class="block">Set the repository cache size, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCacheSize(java.lang.Long)">setCacheSize</a></strong>(java.lang.Long cacheSize)</code> +<div class="block">Set the repository cache size, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointInterval(int)">setCheckpointInterval</a></strong>(int intervalMillis)</code> +<div class="block">Set the interval to run checkpoints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointThresholdKB(int)">setCheckpointThresholdKB</a></strong>(int thresholdKB)</code> +<div class="block">Set the size threshold to run checkpoints.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointThresholdMinutes(int)">setCheckpointThresholdMinutes</a></strong>(int thresholdMinutes)</code> +<div class="block">Set the time threshold to run checkpoints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setChecksumEnabled(java.lang.Boolean)">setChecksumEnabled</a></strong>(java.lang.Boolean checksumEnabled)</code> +<div class="block">When true, enable checksum verification of pages read into the cache + from the backing filestore.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCompressor(java.lang.String, java.lang.String)">setCompressor</a></strong>(java.lang.String type, + java.lang.String compressionType)</code> +<div class="block">Set the compressor for the given class, overriding a custom StorableCodecFactory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabaseHook(com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook)">setDatabaseHook</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> hook)</code> +<div class="block">Sets a hook to be called whenever a database is opened.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabasePageSize(java.lang.Integer, java.lang.Class)">setDatabasePageSize</a></strong>(java.lang.Integer bytes, + java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Sets the desired page size for a given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabasesTransactional(java.lang.Boolean)">setDatabasesTransactional</a></strong>(java.lang.Boolean transactional)</code> +<div class="block">When true, allows databases to be transactional.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDataHome(java.lang.String)">setDataHome</a></strong>(java.lang.String dir)</code> +<div class="block">By default, data files are stored relative to the environment home.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDataHomeFile(java.io.File)">setDataHomeFile</a></strong>(java.io.File dir)</code> +<div class="block">By default, data files are stored relative to the environment home.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setEnvironmentHome(java.lang.String)">setEnvironmentHome</a></strong>(java.lang.String envHome)</code> +<div class="block">Sets the repository environment home directory, which is required.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setEnvironmentHomeFile(java.io.File)">setEnvironmentHomeFile</a></strong>(java.io.File envHome)</code> +<div class="block">Sets the repository environment home directory, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setFileName(java.lang.String, java.lang.String)">setFileName</a></strong>(java.lang.String filename, + java.lang.String typeName)</code> +<div class="block">Specify the file that a BDB database should reside in, except for log + files and caches.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexRepairEnabled(boolean)">setIndexRepairEnabled</a></strong>(boolean enabled)</code> +<div class="block">By default, index repair is enabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexRepairThrottle(double)">setIndexRepairThrottle</a></strong>(double desiredSpeed)</code> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexSupport(boolean)">setIndexSupport</a></strong>(boolean indexSupport)</code> +<div class="block">By default, user specified indexes are supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitialDatabaseConfig(java.lang.Object)">setInitialDatabaseConfig</a></strong>(java.lang.Object dbConfig)</code> +<div class="block">Optionally set the BDB specific database configuration to use + for all databases created.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitialEnvironmentConfig(java.lang.Object)">setInitialEnvironmentConfig</a></strong>(java.lang.Object envConfig)</code> +<div class="block">Optionally set the BDB specific environment configuration to + use.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitializeLogging(boolean)">setInitializeLogging</a></strong>(boolean b)</code> +<div class="block">Ensure the transaction logging sub-system is initialized, which is + usually implied.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setKeepOldLogFiles(boolean)">setKeepOldLogFiles</a></strong>(boolean keep)</code> +<div class="block">By default, transaction log files are deleted when no longer needed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLockConflictDeadlockDetectMode(boolean)">setLockConflictDeadlockDetectMode</a></strong>(boolean b)</code> +<div class="block">Enable deadlock detection whenever a lock conflict occurs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLockTimeout(double)">setLockTimeout</a></strong>(double lockTimeout)</code> +<div class="block">Set the lock timeout, in seconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogFileMaxSize(java.lang.Integer)">setLogFileMaxSize</a></strong>(java.lang.Integer sizeInBytes)</code> +<div class="block">Set the maximum transaction log file size for the BDB environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogInMemory(boolean)">setLogInMemory</a></strong>(boolean logInMemory)</code> +<div class="block">Set true to store transaction logs in memory only instead of persistent + storage.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogRegionSize(int)">setLogRegionSize</a></strong>(int logRegionSize)</code> +<div class="block">Set the repository log region size, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogRegionSize(java.lang.Integer)">setLogRegionSize</a></strong>(java.lang.Integer logRegionSize)</code> +<div class="block">Set the repository log region size, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMaxLocks(java.lang.Integer)">setMaxLocks</a></strong>(java.lang.Integer max)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMultiversion(boolean)">setMultiversion</a></strong>(boolean multiversion)</code> +<div class="block">Set true to enable multiversion concurrency control (MVCC) on BDB + environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPanicHandler(com.amazon.carbonado.repo.sleepycat.BDBPanicHandler)">setPanicHandler</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> handler)</code> +<div class="block">Set the handler to call if the database panics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPreShutdownHook(java.lang.Runnable)">setPreShutdownHook</a></strong>(java.lang.Runnable hook)</code> +<div class="block">Sets a callback to be invoked before the repository has finished running + its own shutdown hooks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPrivate(boolean)">setPrivate</a></strong>(boolean b)</code> +<div class="block">When true, BDB environment cannot be shared by other processes, and + region files are not created.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setProduct(java.lang.String)">setProduct</a></strong>(java.lang.String product)</code> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setReadOnly(boolean)">setReadOnly</a></strong>(boolean readOnly)</code> +<div class="block">Sets the repository to read-only mode.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setReverseSplitOff(boolean)">setReverseSplitOff</a></strong>(boolean off)</code> +<div class="block">Pass true to disable reverse split of B-tree nodes to reduce deadlocks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunCheckpointer(boolean)">setRunCheckpointer</a></strong>(boolean runCheckpointer)</code> +<div class="block">Disable automatic checkpointing of database if another process is + responsible for that.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunDeadlockDetector(boolean)">setRunDeadlockDetector</a></strong>(boolean runDeadlockDetector)</code> +<div class="block">Disable automatic deadlock detection of database if another thread is + responsible for that.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunFullRecovery(boolean)">setRunFullRecovery</a></strong>(boolean runRecovery)</code> +<div class="block">Pass true to override the default and run a full (catastrophic) recovery + when environment is opened.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setShutdownHook(java.lang.Runnable)">setShutdownHook</a></strong>(java.lang.Runnable hook)</code> +<div class="block">Sets a callback to be invoked after repository has finished running its + own shutdown hooks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setSingleFileName(java.lang.String)">setSingleFileName</a></strong>(java.lang.String filename)</code> +<div class="block">Specify that all BDB databases should reside in one file, except for log + files and caches.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setStorableCodecFactory(com.amazon.carbonado.raw.StorableCodecFactory)">setStorableCodecFactory</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> factory)</code> +<div class="block">Override the default storable codec factory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionMaxActive(java.lang.Integer)">setTransactionMaxActive</a></strong>(java.lang.Integer max)</code> +<div class="block">Set the maximum number of concurrent transactions, or pass null to use + the default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionNoSync(boolean)">setTransactionNoSync</a></strong>(boolean noSync)</code> +<div class="block">When true, commits are not immediately written or flushed to disk.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionTimeout(double)">setTransactionTimeout</a></strong>(double txnTimeout)</code> +<div class="block">Set the transaction timeout, in seconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionWriteNoSync(boolean)">setTransactionWriteNoSync</a></strong>(boolean noSync)</code> +<div class="block">When true, commits are written, but they are not flushed to disk.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#verify(java.io.PrintStream)">verify</a></strong>(java.io.PrintStream out)</code> +<div class="block">Opens the BDB environment, checks if it is corrupt, and then closes it.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li> +</ul> +<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> +</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="BDBRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BDBRepositoryBuilder</h4> +<pre>public BDBRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="verify(java.io.PrintStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verify</h4> +<pre>public boolean verify(java.io.PrintStream out) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Opens the BDB environment, checks if it is corrupt, and then closes it. + Only one process should open the environment for verification. Expect it + to take a long time.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - optional stream to capture any verfication errors</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if environment passes verification</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean b)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setProduct(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProduct</h4> +<pre>public void setProduct(java.lang.String product)</pre> +<div class="block">Sets the BDB product to use, which defaults to JE. Also supported is DB + and DB_HA. If not supported, an IllegalArgumentException is thrown.</div> +</li> +</ul> +<a name="getProduct()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProduct</h4> +<pre>public java.lang.String getProduct()</pre> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</li> +</ul> +<a name="setBDBProduct(com.amazon.carbonado.repo.sleepycat.BDBProduct)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBDBProduct</h4> +<pre>public void setBDBProduct(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> product)</pre> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</li> +</ul> +<a name="getBDBProduct()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBDBProduct</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> getBDBProduct()</pre> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</li> +</ul> +<a name="setEnvironmentHomeFile(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnvironmentHomeFile</h4> +<pre>public void setEnvironmentHomeFile(java.io.File envHome)</pre> +<div class="block">Sets the repository environment home directory, which is required.</div> +</li> +</ul> +<a name="getEnvironmentHomeFile()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnvironmentHomeFile</h4> +<pre>public java.io.File getEnvironmentHomeFile()</pre> +<div class="block">Returns the repository environment home directory.</div> +</li> +</ul> +<a name="setEnvironmentHome(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnvironmentHome</h4> +<pre>public void setEnvironmentHome(java.lang.String envHome)</pre> +<div class="block">Sets the repository environment home directory, which is required.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if environment home is not valid</dd></dl> +</li> +</ul> +<a name="getEnvironmentHome()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnvironmentHome</h4> +<pre>public java.lang.String getEnvironmentHome()</pre> +<div class="block">Returns the repository environment home directory.</div> +</li> +</ul> +<a name="setDataHomeFile(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataHomeFile</h4> +<pre>public void setDataHomeFile(java.io.File dir)</pre> +<div class="block">By default, data files are stored relative to the environment home. Call + this method to override. For BDBRepositories that are log files only, + this configuration is ignored.</div> +</li> +</ul> +<a name="getDataHomeFile()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataHomeFile</h4> +<pre>public java.io.File getDataHomeFile()</pre> +<div class="block">Returns the optional directory to store data files. Returns null if data + files are expected to be relative to the environment home.</div> +</li> +</ul> +<a name="setDataHome(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataHome</h4> +<pre>public void setDataHome(java.lang.String dir)</pre> +<div class="block">By default, data files are stored relative to the environment home. Call + this method to override. For BDBRepositories that are log files only, + this configuration is ignored.</div> +</li> +</ul> +<a name="getDataHome()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataHome</h4> +<pre>public java.lang.String getDataHome()</pre> +<div class="block">Returns the directory to store data files.</div> +</li> +</ul> +<a name="setSingleFileName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSingleFileName</h4> +<pre>public void setSingleFileName(java.lang.String filename)</pre> +<div class="block">Specify that all BDB databases should reside in one file, except for log + files and caches. The filename is relative to the environment home, + unless data directories have been specified. For BDBRepositories that + are log files only, this configuration is ignored. + + <p>Note: When setting this option, the storable codec factory must also + be changed, since the default storable codec factory is unable to + distinguish storable types that reside in a single database file. Call + setFileName instead to use built-in BDB feature for supporting multiple + databases in one file.</div> +</li> +</ul> +<a name="getSingleFileName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSingleFileName</h4> +<pre>public java.lang.String getSingleFileName()</pre> +<div class="block">Returns the single file that all BDB databases should reside in.</div> +</li> +</ul> +<a name="setFileName(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFileName</h4> +<pre>public void setFileName(java.lang.String filename, + java.lang.String typeName)</pre> +<div class="block">Specify the file that a BDB database should reside in, except for log + files and caches. The filename is relative to the environment home, + unless data directories have been specified. For BDBRepositories that + are log files only, this configuration is ignored.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - BDB database filename</dd><dd><code>typeName</code> - type to store in file; if null, the file is used by default + for all types</dd></dl> +</li> +</ul> +<a name="setIndexSupport(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexSupport</h4> +<pre>public void setIndexSupport(boolean indexSupport)</pre> +<div class="block">By default, user specified indexes are supported. Pass false to disable + this, and no indexes will be built. Another consequence of this option + is that no unique constraint checks will be applied to alternate keys.</div> +</li> +</ul> +<a name="getIndexSupport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexSupport</h4> +<pre>public boolean getIndexSupport()</pre> +<div class="block">Returns true if indexes are supported, which is true by default.</div> +</li> +</ul> +<a name="isIndexRepairEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexRepairEnabled</h4> +<pre>public boolean isIndexRepairEnabled()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true by default</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexRepairEnabled(boolean)"><code>setIndexRepairEnabled(boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setIndexRepairEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairEnabled</h4> +<pre>public void setIndexRepairEnabled(boolean enabled)</pre> +<div class="block">By default, index repair is enabled. In this mode, the first time a + Storable type is used, new indexes are populated and old indexes are + removed. Until finished, access to the Storable is blocked. + + <p>When index repair is disabled, the Storable is immediately + available. This does have consequences, however. The set of indexes + available for queries is defined by the <i>intersection</i> of the old + and new index sets. The set of indexes that are kept up-to-date is + defined by the <i>union</i> of the old and new index sets. + + <p>While index repair is disabled, another process can safely repair the + indexes in the background. When it is complete, index repair can be + enabled for this repository too.</div> +</li> +</ul> +<a name="getIndexRepairThrottle()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexRepairThrottle</h4> +<pre>public double getIndexRepairThrottle()</pre> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired. By default this value is 1.0, or maximum speed.</div> +</li> +</ul> +<a name="setIndexRepairThrottle(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairThrottle</h4> +<pre>public void setIndexRepairThrottle(double desiredSpeed)</pre> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired. By default this value is 1.0, or maximum speed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desiredSpeed</code> - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work</dd></dl> +</li> +</ul> +<a name="setReadOnly(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadOnly</h4> +<pre>public void setReadOnly(boolean readOnly)</pre> +<div class="block">Sets the repository to read-only mode. By default, repository is opened + for reads and writes.</div> +</li> +</ul> +<a name="getReadOnly()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadOnly</h4> +<pre>public boolean getReadOnly()</pre> +<div class="block">Returns true if repository should be opened read-only.</div> +</li> +</ul> +<a name="setCacheSize(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheSize</h4> +<pre>public void setCacheSize(long cacheSize)</pre> +<div class="block">Set the repository cache size, in bytes. Actual BDB implementation will + select a suitable default if this is not set.</div> +</li> +</ul> +<a name="setCacheSize(java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheSize</h4> +<pre>public void setCacheSize(java.lang.Long cacheSize)</pre> +<div class="block">Set the repository cache size, in bytes. Actual BDB implementation will + select a suitable default if this is not set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cacheSize</code> - cache size to use, or null for default</dd></dl> +</li> +</ul> +<a name="getCacheSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheSize</h4> +<pre>public java.lang.Long getCacheSize()</pre> +<div class="block">Returns the repository cache size, or null if default should be + selected.</div> +</li> +</ul> +<a name="setLogRegionSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogRegionSize</h4> +<pre>public void setLogRegionSize(int logRegionSize)</pre> +<div class="block">Set the repository log region size, in bytes.</div> +</li> +</ul> +<a name="setLogRegionSize(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogRegionSize</h4> +<pre>public void setLogRegionSize(java.lang.Integer logRegionSize)</pre> +<div class="block">Set the repository log region size, in bytes.</div> +</li> +</ul> +<a name="getLogRegionSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogRegionSize</h4> +<pre>public java.lang.Integer getLogRegionSize()</pre> +<div class="block">Returns the repository log region size, or null if the default + should be selected.</div> +</li> +</ul> +<a name="setCachePercent(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCachePercent</h4> +<pre>public void setCachePercent(int cachePercent)</pre> +<div class="block">Set the percent of JVM heap used by the repository cache. Actual + BDB implementation will select a suitable default if this is not + set. This is overridden by setting an explicit cacheSize.</div> +</li> +</ul> +<a name="setCachePercent(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCachePercent</h4> +<pre>public void setCachePercent(java.lang.Integer cachePercent)</pre> +<div class="block">Set the percent of JVM heap used by the repository cache. Actual + BDB implementation will select a suitable default if this is not + set. This is overridden by setting an explicit cacheSize.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cachePercent</code> - percent of JVM heap to use, or null for default</dd></dl> +</li> +</ul> +<a name="getCachePercent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCachePercent</h4> +<pre>public java.lang.Integer getCachePercent()</pre> +<div class="block">Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.</div> +</li> +</ul> +<a name="setLockTimeout(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockTimeout</h4> +<pre>public void setLockTimeout(double lockTimeout)</pre> +<div class="block">Set the lock timeout, in seconds. Default value is 0.5 seconds.</div> +</li> +</ul> +<a name="getLockTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockTimeout</h4> +<pre>public double getLockTimeout()</pre> +<div class="block">Returns the lock timeout, in seconds.</div> +</li> +</ul> +<a name="getLockTimeoutInMicroseconds()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockTimeoutInMicroseconds</h4> +<pre>public long getLockTimeoutInMicroseconds()</pre> +<div class="block">Returns the lock timeout, in microseconds, limited to max long value.</div> +</li> +</ul> +<a name="setMaxLocks(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxLocks</h4> +<pre>public void setMaxLocks(java.lang.Integer max)</pre> +</li> +</ul> +<a name="getMaxLocks()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxLocks</h4> +<pre>public java.lang.Integer getMaxLocks()</pre> +</li> +</ul> +<a name="setTransactionTimeout(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionTimeout</h4> +<pre>public void setTransactionTimeout(double txnTimeout)</pre> +<div class="block">Set the transaction timeout, in seconds. Default value is 300 seconds.</div> +</li> +</ul> +<a name="getTransactionTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionTimeout</h4> +<pre>public double getTransactionTimeout()</pre> +<div class="block">Returns the repository transaction timeout, in seconds.</div> +</li> +</ul> +<a name="getTransactionTimeoutInMicroseconds()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionTimeoutInMicroseconds</h4> +<pre>public long getTransactionTimeoutInMicroseconds()</pre> +<div class="block">Returns the repository transaction timeout, in microseconds, limited to + max long value.</div> +</li> +</ul> +<a name="setTransactionNoSync(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionNoSync</h4> +<pre>public void setTransactionNoSync(boolean noSync)</pre> +<div class="block">When true, commits are not immediately written or flushed to disk. This + improves performance, but there is a chance of losing the most recent + commits if the process is killed or if the machine crashes.</div> +</li> +</ul> +<a name="getTransactionNoSync()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionNoSync</h4> +<pre>public boolean getTransactionNoSync()</pre> +<div class="block">Returns true if transactions are not written or flushed to disk.</div> +</li> +</ul> +<a name="setTransactionWriteNoSync(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionWriteNoSync</h4> +<pre>public void setTransactionWriteNoSync(boolean noSync)</pre> +<div class="block">When true, commits are written, but they are not flushed to disk. This + improves performance, but there is a chance of losing the most recent + commits if the machine crashes.</div> +</li> +</ul> +<a name="getTransactionWriteNoSync()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionWriteNoSync</h4> +<pre>public boolean getTransactionWriteNoSync()</pre> +<div class="block">Returns true if transactions are not flushed to disk.</div> +</li> +</ul> +<a name="setTransactionMaxActive(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionMaxActive</h4> +<pre>public void setTransactionMaxActive(java.lang.Integer max)</pre> +<div class="block">Set the maximum number of concurrent transactions, or pass null to use + the default. This setting has no effect for BDB-JE.</div> +</li> +</ul> +<a name="getTransactionMaxActive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionMaxActive</h4> +<pre>public java.lang.Integer getTransactionMaxActive()</pre> +<div class="block">Returns the maximum number of concurrent transactions, or null if the + default is used.</div> +</li> +</ul> +<a name="setDatabasesTransactional(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDatabasesTransactional</h4> +<pre>public void setDatabasesTransactional(java.lang.Boolean transactional)</pre> +<div class="block">When true, allows databases to be transactional. This setting affects + the databases, not the environment. If this is not explicitly set, the + environment getTransactional is used.</div> +</li> +</ul> +<a name="getDatabasesTransactional()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDatabasesTransactional</h4> +<pre>public java.lang.Boolean getDatabasesTransactional()</pre> +<div class="block">Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set</div> +</li> +</ul> +<a name="setReverseSplitOff(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReverseSplitOff</h4> +<pre>public void setReverseSplitOff(boolean off)</pre> +<div class="block">Pass true to disable reverse split of B-tree nodes to reduce deadlocks. + This setting has no effect for BDB-JE.</div> +</li> +</ul> +<a name="isReverseSplitOff()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isReverseSplitOff</h4> +<pre>public boolean isReverseSplitOff()</pre> +</li> +</ul> +<a name="setDatabasePageSize(java.lang.Integer, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDatabasePageSize</h4> +<pre>public void setDatabasePageSize(java.lang.Integer bytes, + java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<div class="block">Sets the desired page size for a given type. If not specified, the page + size applies to all types.</div> +</li> +</ul> +<a name="setPrivate(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPrivate</h4> +<pre>public void setPrivate(boolean b)</pre> +<div class="block">When true, BDB environment cannot be shared by other processes, and + region files are not created. By default, environment is shared, if + supported.</div> +</li> +</ul> +<a name="isPrivate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrivate</h4> +<pre>public boolean isPrivate()</pre> +<div class="block">Returns true if BDB environment is private. By default, environment is + shared, if supported.</div> +</li> +</ul> +<a name="setMultiversion(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMultiversion</h4> +<pre>public void setMultiversion(boolean multiversion)</pre> +<div class="block">Set true to enable multiversion concurrency control (MVCC) on BDB + environment. This enables snapshot isolation, and is it is not supported + by all BDB products and versions.</div> +</li> +</ul> +<a name="isMultiversion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMultiversion</h4> +<pre>public boolean isMultiversion()</pre> +<div class="block">Returns false by default because multiversion concurrency control (MVCC) + is not enabled.</div> +</li> +</ul> +<a name="setLogInMemory(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogInMemory</h4> +<pre>public void setLogInMemory(boolean logInMemory)</pre> +<div class="block">Set true to store transaction logs in memory only instead of persistent + storage. For BDB products which are entirely log based, no records are + ever persisted.</div> +</li> +</ul> +<a name="getLogInMemory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogInMemory</h4> +<pre>public boolean getLogInMemory()</pre> +<div class="block">Returns false by default, indicating that transaction logs are persisted.</div> +</li> +</ul> +<a name="setLogFileMaxSize(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogFileMaxSize</h4> +<pre>public void setLogFileMaxSize(java.lang.Integer sizeInBytes)</pre> +<div class="block">Set the maximum transaction log file size for the BDB environment.</div> +</li> +</ul> +<a name="getLogFileMaxSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogFileMaxSize</h4> +<pre>public java.lang.Integer getLogFileMaxSize()</pre> +<div class="block">Returns null if default size will be used.</div> +</li> +</ul> +<a name="setInitializeLogging(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitializeLogging</h4> +<pre>public void setInitializeLogging(boolean b)</pre> +<div class="block">Ensure the transaction logging sub-system is initialized, which is + usually implied.</div> +</li> +</ul> +<a name="getInitializeLogging()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitializeLogging</h4> +<pre>public boolean getInitializeLogging()</pre> +</li> +</ul> +<a name="setRunFullRecovery(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRunFullRecovery</h4> +<pre>public void setRunFullRecovery(boolean runRecovery)</pre> +<div class="block">Pass true to override the default and run a full (catastrophic) recovery + when environment is opened. This setting has no effect for BDB-JE.</div> +</li> +</ul> +<a name="getRunFullRecovery()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRunFullRecovery</h4> +<pre>public boolean getRunFullRecovery()</pre> +<div class="block">Returns true if a full (catastrophic) recovery should be performed when + environment is opened.</div> +</li> +</ul> +<a name="setRunCheckpointer(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRunCheckpointer</h4> +<pre>public void setRunCheckpointer(boolean runCheckpointer)</pre> +<div class="block">Disable automatic checkpointing of database if another process is + responsible for that. The false setting is implied for read-only + databases.</div> +</li> +</ul> +<a name="getRunCheckpointer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRunCheckpointer</h4> +<pre>public boolean getRunCheckpointer()</pre> +<div class="block">Returns true if checkpointer is run automatically.</div> +</li> +</ul> +<a name="setCheckpointInterval(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointInterval</h4> +<pre>public void setCheckpointInterval(int intervalMillis)</pre> +<div class="block">Set the interval to run checkpoints. This setting is ignored if the + checkpointer is not configured to run.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>intervalMillis</code> - interval between checkpoints, in milliseconds</dd></dl> +</li> +</ul> +<a name="getCheckpointInterval()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointInterval</h4> +<pre>public int getCheckpointInterval()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>interval between checkpoints, in milliseconds</dd></dl> +</li> +</ul> +<a name="setCheckpointThresholdKB(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointThresholdKB</h4> +<pre>public void setCheckpointThresholdKB(int thresholdKB)</pre> +<div class="block">Set the size threshold to run checkpoints. This setting is ignored if + the checkpointer is not configured to run. Default value is 1024 KB. + + <p>Checkpoint threshold is only used by Carbonado's built-in + checkpointer, and is ignored when using BDB-JE.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thresholdKB</code> - run checkpoint if at least this many kilobytes in log</dd></dl> +</li> +</ul> +<a name="getCheckpointThresholdKB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointThresholdKB</h4> +<pre>public int getCheckpointThresholdKB()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>run checkpoint if at least this many kilobytes in log</dd></dl> +</li> +</ul> +<a name="setCheckpointThresholdMinutes(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointThresholdMinutes</h4> +<pre>public void setCheckpointThresholdMinutes(int thresholdMinutes)</pre> +<div class="block">Set the time threshold to run checkpoints. This setting is ignored if + the checkpointer is not configured to run. Default value is 1 minute. + + <p>Checkpoint threshold is only used by Carbonado's built-in + checkpointer, and is ignored when using BDB-JE.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thresholdMinutes</code> - run checkpoint if at least this many minutes + passed since last checkpoint</dd></dl> +</li> +</ul> +<a name="getCheckpointThresholdMinutes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointThresholdMinutes</h4> +<pre>public int getCheckpointThresholdMinutes()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>run checkpoint if at least this many minutes passed since last + checkpoint</dd></dl> +</li> +</ul> +<a name="setKeepOldLogFiles(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setKeepOldLogFiles</h4> +<pre>public void setKeepOldLogFiles(boolean keep)</pre> +<div class="block">By default, transaction log files are deleted when no longer needed. + Keeping log files can be used for incremental backups or for diagnosing + problems. If using BDB-JE, old log files are renamed with a ".del" + extension. If using BDB-core, the db_archive utility is required for + identifying old log files.</div> +</li> +</ul> +<a name="getKeepOldLogFiles()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeepOldLogFiles</h4> +<pre>public boolean getKeepOldLogFiles()</pre> +<div class="block">Returns false by default.</div> +</li> +</ul> +<a name="setRunDeadlockDetector(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRunDeadlockDetector</h4> +<pre>public void setRunDeadlockDetector(boolean runDeadlockDetector)</pre> +<div class="block">Disable automatic deadlock detection of database if another thread is + responsible for that.</div> +</li> +</ul> +<a name="getRunDeadlockDetector()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRunDeadlockDetector</h4> +<pre>public boolean getRunDeadlockDetector()</pre> +<div class="block">Returns true if deadlock detector is configured to run.</div> +</li> +</ul> +<a name="setLockConflictDeadlockDetectMode(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockConflictDeadlockDetectMode</h4> +<pre>public void setLockConflictDeadlockDetectMode(boolean b)</pre> +<div class="block">Enable deadlock detection whenever a lock conflict occurs. Default is + off, and it has no effect for BDB-JE.</div> +</li> +</ul> +<a name="getLockConflictDeadlockDetectMode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockConflictDeadlockDetectMode</h4> +<pre>public boolean getLockConflictDeadlockDetectMode()</pre> +<div class="block">Returns true if deadlock detection is run whenever a lock conflict occurs.</div> +</li> +</ul> +<a name="setChecksumEnabled(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setChecksumEnabled</h4> +<pre>public void setChecksumEnabled(java.lang.Boolean checksumEnabled)</pre> +<div class="block">When true, enable checksum verification of pages read into the cache + from the backing filestore. By default checksum is enabled for BDB-JE, + and disabled for BDB-C.</div> +</li> +</ul> +<a name="getChecksumEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChecksumEnabled</h4> +<pre>public java.lang.Boolean getChecksumEnabled()</pre> +<div class="block">Returns true if checksum verification is enabled. Returns null if the + BDB default is used.</div> +</li> +</ul> +<a name="setInitialEnvironmentConfig(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitialEnvironmentConfig</h4> +<pre>public void setInitialEnvironmentConfig(java.lang.Object envConfig)</pre> +<div class="block">Optionally set the BDB specific environment configuration to + use. The builder will verify that needed configuration values are set.</div> +</li> +</ul> +<a name="getInitialEnvironmentConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialEnvironmentConfig</h4> +<pre>public java.lang.Object getInitialEnvironmentConfig()</pre> +<div class="block">Returns the optional BDB specific environment configuration to use.</div> +</li> +</ul> +<a name="setInitialDatabaseConfig(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitialDatabaseConfig</h4> +<pre>public void setInitialDatabaseConfig(java.lang.Object dbConfig)</pre> +<div class="block">Optionally set the BDB specific database configuration to use + for all databases created. The storage will verify that needed + configuration values are set.</div> +</li> +</ul> +<a name="getInitialDatabaseConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialDatabaseConfig</h4> +<pre>public java.lang.Object getInitialDatabaseConfig()</pre> +<div class="block">Returns the optional BDB specific database configuration to use + for all databases created.</div> +</li> +</ul> +<a name="setStorableCodecFactory(com.amazon.carbonado.raw.StorableCodecFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStorableCodecFactory</h4> +<pre>public void setStorableCodecFactory(<a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> factory)</pre> +<div class="block">Override the default storable codec factory.</div> +</li> +</ul> +<a name="getStorableCodecFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableCodecFactory</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> getStorableCodecFactory()</pre> +<div class="block">Returns the storable codec factory used.</div> +</li> +</ul> +<a name="setPreShutdownHook(java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPreShutdownHook</h4> +<pre>public void setPreShutdownHook(java.lang.Runnable hook)</pre> +<div class="block">Sets a callback to be invoked before the repository has finished running + its own shutdown hooks. This method is also invoked when repository is + manually closed.</div> +</li> +</ul> +<a name="getPreShutdownHook()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreShutdownHook</h4> +<pre>public java.lang.Runnable getPreShutdownHook()</pre> +<div class="block">Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.</div> +</li> +</ul> +<a name="setShutdownHook(java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setShutdownHook</h4> +<pre>public void setShutdownHook(java.lang.Runnable hook)</pre> +<div class="block">Sets a callback to be invoked after repository has finished running its + own shutdown hooks. This method is also invoked when repository is + manually closed.</div> +</li> +</ul> +<a name="getShutdownHook()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShutdownHook</h4> +<pre>public java.lang.Runnable getShutdownHook()</pre> +<div class="block">Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.</div> +</li> +</ul> +<a name="setDatabaseHook(com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDatabaseHook</h4> +<pre>public void setDatabaseHook(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> hook)</pre> +<div class="block">Sets a hook to be called whenever a database is opened.</div> +</li> +</ul> +<a name="getDatabaseHook()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDatabaseHook</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> getDatabaseHook()</pre> +<div class="block">Returns the custom open database hook, or null if none.</div> +</li> +</ul> +<a name="setCompressor(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCompressor</h4> +<pre>public void setCompressor(java.lang.String type, + java.lang.String compressionType)</pre> +<div class="block">Set the compressor for the given class, overriding a custom StorableCodecFactory.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Storable to compress.</dd><dd><code>compressionType</code> - String representation of type of + compression. Available options are "NONE" for no compression or "GZIP" + for gzip compression</dd></dl> +</li> +</ul> +<a name="getCompressor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCompressor</h4> +<pre>public java.lang.String getCompressor(java.lang.String type)</pre> +<div class="block">Return the compressor used for the given storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Storable to compress</dd> +<dt><span class="strong">Returns:</span></dt><dd>String representation of the type of compression used. Available options are "NONE" + for no compression and "GZIP" for gzip compression.</dd></dl> +</li> +</ul> +<a name="setPanicHandler(com.amazon.carbonado.repo.sleepycat.BDBPanicHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPanicHandler</h4> +<pre>public void setPanicHandler(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> handler)</pre> +<div class="block">Set the handler to call if the database panics.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - </dd></dl> +</li> +</ul> +<a name="getPanicHandler()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPanicHandler</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> getPanicHandler()</pre> +<div class="block">Return the panic handler to call if the database panics.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The BDBPanicHandler or null if unset.</dd></dl> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/BDBRepositoryBuilder.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/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html new file mode 100644 index 0000000..9d9eaf1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html @@ -0,0 +1,291 @@ +<!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>CheckpointCapability (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="CheckpointCapability (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/CheckpointCapability.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/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" target="_top">Frames</a></li> +<li><a href="CheckpointCapability.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.sleepycat</div> +<h2 title="Interface CheckpointCapability" class="title">Interface CheckpointCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">CheckpointCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability to control BDB checkpointing.</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/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><code>HotBackupCapability</code></a></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/repo/sleepycat/CheckpointCapability.html#forceCheckpoint()">forceCheckpoint</a></strong>()</code> +<div class="block">Forces a checkpoint to run now, even if checkpointer is suspended or + disabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#resumeCheckpointer()">resumeCheckpointer</a></strong>()</code> +<div class="block">Resumes the checkpointer if it was suspended.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#suspendCheckpointer(long)">suspendCheckpointer</a></strong>(long suspensionTime)</code> +<div class="block">Suspend the checkpointer until the suspension time has expired or until + manually resumed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#sync()">sync</a></strong>()</code> +<div class="block">Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.</div> +</td> +</tr> +</table> +</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="suspendCheckpointer(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>suspendCheckpointer</h4> +<pre>void suspendCheckpointer(long suspensionTime)</pre> +<div class="block">Suspend the checkpointer until the suspension time has expired or until + manually resumed. If a checkpoint is in progress, this method will block + until it is finished. If checkpointing is disabled, calling this method + has no effect. + + <p>Calling this method repeatedly resets the suspension time. Each + invocation of suspendCheckpointer is like a lease renewal or heartbeat.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>suspensionTime</code> - minimum length of suspension, in milliseconds, + unless checkpointer is manually resumed</dd></dl> +</li> +</ul> +<a name="resumeCheckpointer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resumeCheckpointer</h4> +<pre>void resumeCheckpointer()</pre> +<div class="block">Resumes the checkpointer if it was suspended. If checkpointing is + disabled or if not suspended, calling this method has no effect.</div> +</li> +</ul> +<a name="forceCheckpoint()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forceCheckpoint</h4> +<pre>void forceCheckpoint() + throws <a href="../../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Forces a checkpoint to run now, even if checkpointer is suspended or + disabled. If a checkpoint is in progress, then this method will block + until it is finished, and then run another checkpoint. This method does + not return until the requested checkpoint has finished.</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></dd></dl> +</li> +</ul> +<a name="sync()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sync</h4> +<pre>void sync() + throws <a href="../../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.</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></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</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/CheckpointCapability.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/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" target="_top">Frames</a></li> +<li><a href="CheckpointCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html new file mode 100644 index 0000000..bea8c9d --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html @@ -0,0 +1,264 @@ +<!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>CompactionCapability.Result (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="CompactionCapability.Result (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/CompactionCapability.Result.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/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" target="_top">Frames</a></li> +<li><a href="CompactionCapability.Result.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.sleepycat</div> +<h2 title="Interface CompactionCapability.Result" class="title">Interface CompactionCapability.Result<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>Enclosing interface:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">CompactionCapability.Result<S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getDeadlockCount()">getDeadlockCount</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getLevels()">getLevels</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesExamine()">getPagesExamine</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesFree()">getPagesFree</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesTruncated()">getPagesTruncated</a></strong>()</code> </td> +</tr> +</table> +</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="getPagesExamine()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPagesExamine</h4> +<pre>int getPagesExamine()</pre> +</li> +</ul> +<a name="getPagesFree()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPagesFree</h4> +<pre>int getPagesFree()</pre> +</li> +</ul> +<a name="getPagesTruncated()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPagesTruncated</h4> +<pre>int getPagesTruncated()</pre> +</li> +</ul> +<a name="getLevels()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLevels</h4> +<pre>int getLevels()</pre> +</li> +</ul> +<a name="getDeadlockCount()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDeadlockCount</h4> +<pre>int getDeadlockCount()</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/CompactionCapability.Result.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/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" target="_top">Frames</a></li> +<li><a href="CompactionCapability.Result.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html new file mode 100644 index 0000000..1b0e2e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/CompactionCapability.html @@ -0,0 +1,244 @@ +<!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>CompactionCapability (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="CompactionCapability (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/CompactionCapability.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/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" target="_top">Frames</a></li> +<li><a href="CompactionCapability.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>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.sleepycat</div> +<h2 title="Interface CompactionCapability" class="title">Interface CompactionCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">CompactionCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability to compact a BDB database. This capability is not supported by + all versions of BDB.</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"> +<!-- ======== 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">Interface 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/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a><<a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="type parameter in CompactionCapability.Result">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></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><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html#compact(java.lang.Class)">compact</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Compact an entire BDB backed storage.</div> +</td> +</tr> +</table> +</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="compact(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>compact</h4> +<pre><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a><S> compact(java.lang.Class<S> storableType) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Compact an entire BDB backed storage. This call may be made within a + transaction scope.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storableType</code> - required storable type</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/CompactionCapability.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/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" target="_top">Frames</a></li> +<li><a href="CompactionCapability.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>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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html new file mode 100644 index 0000000..08405e2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html @@ -0,0 +1,284 @@ +<!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>EnvironmentCapability (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="EnvironmentCapability (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/EnvironmentCapability.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/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" target="_top">Frames</a></li> +<li><a href="EnvironmentCapability.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.sleepycat</div> +<h2 title="Interface EnvironmentCapability" class="title">Interface EnvironmentCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">EnvironmentCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability to provide direct access to the underlying BDB environment.</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><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getBDBProduct()">getBDBProduct</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getDataHome()">getDataHome</a></strong>()</code> +<div class="block">Returns the directory where data files are stored, which is the same as + the home directory by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getEnvironment()">getEnvironment</a></strong>()</code> +<div class="block">Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getHome()">getHome</a></strong>()</code> +<div class="block">Returns the home directory for the BDB environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getVersion()">getVersion</a></strong>()</code> +<div class="block">Returns the major, minor, and patch version numbers.</div> +</td> +</tr> +</table> +</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="getEnvironment()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnvironment</h4> +<pre>java.lang.Object getEnvironment()</pre> +<div class="block">Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.</div> +</li> +</ul> +<a name="getBDBProduct()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBDBProduct</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> getBDBProduct()</pre> +</li> +</ul> +<a name="getVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersion</h4> +<pre>int[] getVersion()</pre> +<div class="block">Returns the major, minor, and patch version numbers.</div> +</li> +</ul> +<a name="getHome()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHome</h4> +<pre>java.io.File getHome()</pre> +<div class="block">Returns the home directory for the BDB environment.</div> +</li> +</ul> +<a name="getDataHome()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDataHome</h4> +<pre>java.io.File getDataHome()</pre> +<div class="block">Returns the directory where data files are stored, which is the same as + the home directory by default.</div> +</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/EnvironmentCapability.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/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" target="_top">Frames</a></li> +<li><a href="EnvironmentCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html new file mode 100644 index 0000000..e6dfea5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html @@ -0,0 +1,309 @@ +<!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>HotBackupCapability.Backup (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="HotBackupCapability.Backup (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/HotBackupCapability.Backup.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/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" target="_top">Frames</a></li> +<li><a href="HotBackupCapability.Backup.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.sleepycat</div> +<h2 title="Interface HotBackupCapability.Backup" class="title">Interface HotBackupCapability.Backup</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">HotBackupCapability.Backup</span></pre> +</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/repo/sleepycat/HotBackupCapability.Backup.html#endBackup()">endBackup</a></strong>()</code> +<div class="block">Resume normal operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getDataFiles()">getDataFiles</a></strong>()</code> +<div class="block">Returns all the data files to be copied.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getFiles()">getFiles</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use getDataFiles and getLogFiles</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLastLogNumber()">getLastLogNumber</a></strong>()</code> +<div class="block">Can be called after a backup has been performed to find the last log file + that has been backed up.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLogFiles()">getLogFiles</a></strong>()</code> +<div class="block">Returns all the transaction log files to be copied, in the exact + order in which they must be copied.</div> +</td> +</tr> +</table> +</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="endBackup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>endBackup</h4> +<pre>void endBackup() + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Resume normal operation.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="getFiles()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFiles</h4> +<pre>@Deprecated +java.io.File[] getFiles() + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> <i>use getDataFiles and getLogFiles</i></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="getDataFiles()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataFiles</h4> +<pre>java.io.File[] getDataFiles() + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns all the data files to be copied. After these files are + durably copied, call <a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLogFiles()"><code>getLogFiles()</code></a> and copy the log files + which were created while the data files were copied.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>array of data files, which might be empty</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="getLogFiles()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogFiles</h4> +<pre>java.io.File[] getLogFiles() + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns all the transaction log files to be copied, in the exact + order in which they must be copied. After these files are durably + copied, call <a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#endBackup()"><code>endBackup()</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>array of transaction log files, never empty</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="getLastLogNumber()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLastLogNumber</h4> +<pre>long getLastLogNumber() + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Can be called after a backup has been performed to find the last log file + that has been backed up.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the file number of the last file in the current backup set. + This number is required to perform incremental backups.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if <a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getFiles()"><code>getFiles()</code></a> was not called</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/HotBackupCapability.Backup.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/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" target="_top">Frames</a></li> +<li><a href="HotBackupCapability.Backup.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html new file mode 100644 index 0000000..a3632c0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html @@ -0,0 +1,333 @@ +<!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>HotBackupCapability (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="HotBackupCapability (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/HotBackupCapability.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/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" target="_top">Frames</a></li> +<li><a href="HotBackupCapability.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>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.sleepycat</div> +<h2 title="Interface HotBackupCapability" class="title">Interface HotBackupCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">HotBackupCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for performing a backup of an active BDB environment. If <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogInMemory(boolean)"><code>in-memory logging</code></a> is enabled, + backups cannot be performed. To restore from a hot backup, it is + <b>critical</b> that a full recovery be performed. Pass true to <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunFullRecovery(boolean)"><code>setRunFullRecovery</code></a> to + enable. <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#JE"><code>BDB-JE</code></a> does not require this, however. + + <p>To support incremental backups against the <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#DB"><code>native + BDB product</code></a>, old log files must be kept. Pass true to <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setKeepOldLogFiles(boolean)"><code>setKeepOldLogFiles</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Olga Kuznetsova</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">Interface 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/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></strong></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/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup()">startBackup</a></strong>()</code> +<div class="block">Starts the backup by disabling log file deletion.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup(boolean)">startBackup</a></strong>(boolean deleteOldLogFiles)</code> +<div class="block">Starts the backup by disabling log file deletion.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long)">startIncrementalBackup</a></strong>(long lastLogNumber)</code> +<div class="block">Starts an incremental backup.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long, boolean)">startIncrementalBackup</a></strong>(long lastLogNumber, + boolean deleteOldLogFiles)</code> +<div class="block">Starts an incremental backup.</div> +</td> +</tr> +</table> +</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="startBackup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startBackup</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a> startBackup() + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Starts the backup by disabling log file deletion. Be sure to call + endBackup when done to resume log file cleanup. Concurrent backups are + supported.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if configuration doesn't support backups</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="startBackup(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startBackup</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a> startBackup(boolean deleteOldLogFiles) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Starts the backup by disabling log file deletion. Be sure to call + endBackup when done to resume log file cleanup. Concurrent backups are supported. + + <p>Caution should be observed when deleting old log files by force, if + an external process is also performing backups. If a concurrent backup + is issued by this repository instance, log file deletion is suppressed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>deleteOldLogFiles</code> - deletes log files that are no longer in use and + have been backed up. False by default.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if configuration doesn't support backups</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="startIncrementalBackup(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startIncrementalBackup</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a> startIncrementalBackup(long lastLogNumber) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Starts an incremental backup. Log files that are newer than the + lastLogNumber will be copied during the backup. Should only be run after + performing a full backup.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lastLogNumber</code> - number of the last log file that was copied in a previous backup</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if lastLogNumber is negative</dd> +<dd><code>java.lang.IllegalStateException</code> - if configuration doesn't support backups</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="startIncrementalBackup(long, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>startIncrementalBackup</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a> startIncrementalBackup(long lastLogNumber, + boolean deleteOldLogFiles) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Starts an incremental backup. Log files that are newer than the lastLogNumber will be copied + during the backup. Can only be run after performing a full backup. + + <p>Caution should be observed when deleting old log files by force, if + an external process is also performing backups. If a concurrent backup + is issued by this repository instance, log file deletion is suppressed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lastLogNumber</code> - number of the last log file that was copied in a previous backup.</dd><dd><code>deleteOldLogFiles</code> - deletes log files that are no longer in use and + have been backed up. False by default.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if lastLogNumber is negative</dd> +<dd><code>java.lang.IllegalStateException</code> - if configuration doesn't support backups</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/HotBackupCapability.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/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" target="_top">Frames</a></li> +<li><a href="HotBackupCapability.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>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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html b/apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html new file mode 100644 index 0000000..dbd7d87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html @@ -0,0 +1,537 @@ +<!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>StoredDatabaseInfo (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="StoredDatabaseInfo (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/StoredDatabaseInfo.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/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" target="_top">Frames</a></li> +<li><a href="StoredDatabaseInfo.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.repo.sleepycat</div> +<h2 title="Class StoredDatabaseInfo" class="title">Class StoredDatabaseInfo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo</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/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>, <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</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>="databaseName") +<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_DATABASE_INFO") +public abstract class <span class="strong">StoredDatabaseInfo</span> +extends java.lang.Object +implements <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 BDB databases managed by BDBRepository. + + <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"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#EVOLUTION_NONE">EVOLUTION_NONE</a></strong></code> +<div class="block">Evolution strategy code</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#EVOLUTION_STANDARD">EVOLUTION_STANDARD</a></strong></code> +<div class="block">Evolution strategy code</div> +</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/repo/sleepycat/StoredDatabaseInfo.html#StoredDatabaseInfo()">StoredDatabaseInfo</a></strong>()</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>abstract long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.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>abstract java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getDatabaseName()">getDatabaseName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getEvolutionStrategy()">getEvolutionStrategy</a></strong>()</code> +<div class="block">Returns EVOLUTION_NONE if evolution of records is not supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.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>abstract java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getIndexNameDescriptor()">getIndexNameDescriptor</a></strong>()</code> +<div class="block">Returns the index name descriptor for the keys of this database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.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>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getVersionNumber()">getVersionNumber</a></strong>()</code> +<div class="block">Record version number for this StoredDatabaseInfo instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setCreationTimestamp(long)">setCreationTimestamp</a></strong>(long timestamp)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setDatabaseName(java.lang.String)">setDatabaseName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setEvolutionStrategy(int)">setEvolutionStrategy</a></strong>(int strategy)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setExtraData(byte[])">setExtraData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setIndexNameDescriptor(java.lang.String)">setIndexNameDescriptor</a></strong>(java.lang.String descriptor)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setIndexTypeDescriptor(java.lang.String)">setIndexTypeDescriptor</a></strong>(java.lang.String descriptor)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setVersionNumber(int)">setVersionNumber</a></strong>(int version)</code> </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.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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="EVOLUTION_NONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EVOLUTION_NONE</h4> +<pre>public static final int EVOLUTION_NONE</pre> +<div class="block">Evolution strategy code</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo.EVOLUTION_NONE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="EVOLUTION_STANDARD"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EVOLUTION_STANDARD</h4> +<pre>public static final int EVOLUTION_STANDARD</pre> +<div class="block">Evolution strategy code</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo.EVOLUTION_STANDARD">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StoredDatabaseInfo()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StoredDatabaseInfo</h4> +<pre>public StoredDatabaseInfo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getDatabaseName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDatabaseName</h4> +<pre>public abstract java.lang.String getDatabaseName()</pre> +</li> +</ul> +<a name="setDatabaseName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDatabaseName</h4> +<pre>public abstract void setDatabaseName(java.lang.String name)</pre> +</li> +</ul> +<a name="getIndexNameDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexNameDescriptor</h4> +<pre><a href="../../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado">@Nullable</a> +public abstract java.lang.String getIndexNameDescriptor()</pre> +<div class="block">Returns the index name descriptor for the keys of this database. This + descriptor is defined by <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a>, and + it does not contain type information.</div> +</li> +</ul> +<a name="setIndexNameDescriptor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexNameDescriptor</h4> +<pre>public abstract void setIndexNameDescriptor(java.lang.String descriptor)</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> +public abstract 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>public abstract void setIndexTypeDescriptor(java.lang.String descriptor)</pre> +</li> +</ul> +<a name="getEvolutionStrategy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEvolutionStrategy</h4> +<pre>public abstract int getEvolutionStrategy()</pre> +<div class="block">Returns EVOLUTION_NONE if evolution of records is not supported.</div> +</li> +</ul> +<a name="setEvolutionStrategy(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEvolutionStrategy</h4> +<pre>public abstract void setEvolutionStrategy(int strategy)</pre> +</li> +</ul> +<a name="getCreationTimestamp()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreationTimestamp</h4> +<pre>public abstract 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>public abstract 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> +public abstract int getVersionNumber()</pre> +<div class="block">Record version number for this StoredDatabaseInfo 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>public abstract 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> +public abstract 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>public abstract 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/StoredDatabaseInfo.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/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" target="_top">Frames</a></li> +<li><a href="StoredDatabaseInfo.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html new file mode 100644 index 0000000..37bc176 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html @@ -0,0 +1,177 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBPanicHandler (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="Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBPanicHandler (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html" target="_top">Frames</a></li> +<li><a href="BDBPanicHandler.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBPanicHandler" class="title">Uses of Interface<br>com.amazon.carbonado.repo.sleepycat.BDBPanicHandler</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that return <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a></code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPanicHandler()">getPanicHandler</a></strong>()</code> +<div class="block">Return the panic handler to call if the database panics.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with parameters of type <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPanicHandler(com.amazon.carbonado.repo.sleepycat.BDBPanicHandler)">setPanicHandler</a></strong>(<a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> handler)</code> +<div class="block">Set the handler to call if the database panics.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html" target="_top">Frames</a></li> +<li><a href="BDBPanicHandler.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html new file mode 100644 index 0000000..62c74c4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html @@ -0,0 +1,198 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.sleepycat.BDBProduct (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="Uses of Class com.amazon.carbonado.repo.sleepycat.BDBProduct (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html" target="_top">Frames</a></li> +<li><a href="BDBProduct.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.sleepycat.BDBProduct" class="title">Uses of Class<br>com.amazon.carbonado.repo.sleepycat.BDBProduct</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that return <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><span class="strong">BDBProduct.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#forString(java.lang.String)">forString</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><span class="strong">EnvironmentCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getBDBProduct()">getBDBProduct</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getBDBProduct()">getBDBProduct</a></strong>()</code> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><span class="strong">BDBProduct.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a>[]</code></td> +<td class="colLast"><span class="strong">BDBProduct.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with parameters of type <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setBDBProduct(com.amazon.carbonado.repo.sleepycat.BDBProduct)">setBDBProduct</a></strong>(<a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> product)</code> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html" target="_top">Frames</a></li> +<li><a href="BDBProduct.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html new file mode 100644 index 0000000..80663c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html @@ -0,0 +1,177 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook (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="Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.DatabaseHook.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook" class="title">Uses of Interface<br>com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that return <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabaseHook()">getDatabaseHook</a></strong>()</code> +<div class="block">Returns the custom open database hook, or null if none.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> with parameters of type <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">BDBRepositoryBuilder.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabaseHook(com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook)">setDatabaseHook</a></strong>(<a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> hook)</code> +<div class="block">Sets a hook to be called whenever a database is opened.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.DatabaseHook.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html new file mode 100644 index 0000000..80aede2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder (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="Uses of Class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html new file mode 100644 index 0000000..445c753 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability (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="Uses of Interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html" target="_top">Frames</a></li> +<li><a href="CheckpointCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability" class="title">Uses of Interface<br>com.amazon.carbonado.repo.sleepycat.CheckpointCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.sleepycat.CheckpointCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/CheckpointCapability.html" target="_top">Frames</a></li> +<li><a href="CheckpointCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html new file mode 100644 index 0000000..d3ab8dc --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result (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="Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html" target="_top">Frames</a></li> +<li><a href="CompactionCapability.Result.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result" class="title">Uses of Interface<br>com.amazon.carbonado.repo.sleepycat.CompactionCapability.Result</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a> in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that return <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a><S></code></td> +<td class="colLast"><span class="strong">CompactionCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html#compact(java.lang.Class)">compact</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Compact an entire BDB backed storage.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html" target="_top">Frames</a></li> +<li><a href="CompactionCapability.Result.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html new file mode 100644 index 0000000..f810a9f --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability (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="Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html" target="_top">Frames</a></li> +<li><a href="CompactionCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.sleepycat.CompactionCapability" class="title">Uses of Interface<br>com.amazon.carbonado.repo.sleepycat.CompactionCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.sleepycat.CompactionCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.html" target="_top">Frames</a></li> +<li><a href="CompactionCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html new file mode 100644 index 0000000..9a62e14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability (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="Uses of Interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html" target="_top">Frames</a></li> +<li><a href="EnvironmentCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.sleepycat.EnvironmentCapability" class="title">Uses of Interface<br>com.amazon.carbonado.repo.sleepycat.EnvironmentCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.sleepycat.EnvironmentCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/EnvironmentCapability.html" target="_top">Frames</a></li> +<li><a href="EnvironmentCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html new file mode 100644 index 0000000..e2700fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html @@ -0,0 +1,181 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup (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="Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html" target="_top">Frames</a></li> +<li><a href="HotBackupCapability.Backup.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup" class="title">Uses of Interface<br>com.amazon.carbonado.repo.sleepycat.HotBackupCapability.Backup</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a> in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> that return <a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><span class="strong">HotBackupCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup()">startBackup</a></strong>()</code> +<div class="block">Starts the backup by disabling log file deletion.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><span class="strong">HotBackupCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup(boolean)">startBackup</a></strong>(boolean deleteOldLogFiles)</code> +<div class="block">Starts the backup by disabling log file deletion.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><span class="strong">HotBackupCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long)">startIncrementalBackup</a></strong>(long lastLogNumber)</code> +<div class="block">Starts an incremental backup.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td> +<td class="colLast"><span class="strong">HotBackupCapability.</span><code><strong><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long, boolean)">startIncrementalBackup</a></strong>(long lastLogNumber, + boolean deleteOldLogFiles)</code> +<div class="block">Starts an incremental backup.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html" target="_top">Frames</a></li> +<li><a href="HotBackupCapability.Backup.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html new file mode 100644 index 0000000..30aef75 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability (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="Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html" target="_top">Frames</a></li> +<li><a href="HotBackupCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.repo.sleepycat.HotBackupCapability" class="title">Uses of Interface<br>com.amazon.carbonado.repo.sleepycat.HotBackupCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.sleepycat.HotBackupCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.html" target="_top">Frames</a></li> +<li><a href="HotBackupCapability.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html new file mode 100644 index 0000000..4edaf72 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo (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="Uses of Class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo (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><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html" target="_top">Frames</a></li> +<li><a href="StoredDatabaseInfo.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"> +<h2 title="Uses of Class com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo" class="title">Uses of Class<br>com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.repo.sleepycat.StoredDatabaseInfo</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?com/amazon/carbonado/repo/sleepycat/class-use/StoredDatabaseInfo.html" target="_top">Frames</a></li> +<li><a href="StoredDatabaseInfo.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-frame.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-frame.html new file mode 100644 index 0000000..2c7c7b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-frame.html @@ -0,0 +1,36 @@ +<!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.repo.sleepycat (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> +<h1 class="bar"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html" target="classFrame">com.amazon.carbonado.repo.sleepycat</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat" target="classFrame"><i>BDBPanicHandler</i></a></li> +<li><a href="BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat" target="classFrame"><i>BDBRepositoryBuilder.DatabaseHook</i></a></li> +<li><a href="CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat" target="classFrame"><i>CheckpointCapability</i></a></li> +<li><a href="CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat" target="classFrame"><i>CompactionCapability</i></a></li> +<li><a href="CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat" target="classFrame"><i>CompactionCapability.Result</i></a></li> +<li><a href="EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat" target="classFrame"><i>EnvironmentCapability</i></a></li> +<li><a href="HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat" target="classFrame"><i>HotBackupCapability</i></a></li> +<li><a href="HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat" target="classFrame"><i>HotBackupCapability.Backup</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat" target="classFrame">BDBRepositoryBuilder</a></li> +<li><a href="StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat" target="classFrame">StoredDatabaseInfo</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat" target="classFrame">BDBProduct</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html new file mode 100644 index 0000000..37f4909 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-summary.html @@ -0,0 +1,228 @@ +<!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.repo.sleepycat (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.repo.sleepycat (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><a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/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.repo.sleepycat</h1> +<div class="docSummary"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</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/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a></td> +<td class="colLast"> +<div class="block">Interface for a generic panic handler for any BDB products.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a></td> +<td class="colLast"> +<div class="block">Capability to control BDB checkpointing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability</a></td> +<td class="colLast"> +<div class="block">Capability to compact a BDB database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></td> +<td class="colLast"> +<div class="block">Capability to provide direct access to the underlying BDB environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a></td> +<td class="colLast"> +<div class="block">Capability for performing a backup of an active BDB environment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></td> +<td class="colLast"> </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/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Builder and configuration options for BDBRepository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></td> +<td class="colLast"> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</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/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></td> +<td class="colLast"> +<div class="block">Set of supported BDB products.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.repo.sleepycat Description">Package com.amazon.carbonado.repo.sleepycat Description</h2> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database. Data is encoded in a specialized format, and so this repository + should not be used to open arbitrary Berkeley databases. BDBRepository has + total schema ownership, and so it updates type definitions in the storage + layer automatically.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat"><code>BDBRepositoryBuilder</code></a></dd></dl> +</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><a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-tree.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-tree.html new file mode 100644 index 0000000..bb0eaa6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-tree.html @@ -0,0 +1,162 @@ +<!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.repo.sleepycat Class Hierarchy (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.repo.sleepycat Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/replicated/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.repo.sleepycat</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>) +<ul> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">BDBRepositoryBuilder</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">StoredDatabaseInfo</span></a> (implements com.amazon.carbonado.<a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>, com.amazon.carbonado.layout.<a href="../../../../../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout">Unevolvable</a>, com.amazon.carbonado.repo.indexed.<a href="../../../../../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed">Unindexed</a>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">BDBPanicHandler</span></a></li> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">BDBRepositoryBuilder.DatabaseHook</span></a></li> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">CheckpointCapability</span></a></li> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">CompactionCapability</span></a></li> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">EnvironmentCapability</span></a></li> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">HotBackupCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">CompactionCapability.Result</span></a><S></li> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">HotBackupCapability.Backup</span></a></li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.repo.sleepycat.<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat"><span class="strong">BDBProduct</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/replicated/package-tree.html">Prev</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/package-use.html b/apidocs/com/amazon/carbonado/repo/sleepycat/package-use.html new file mode 100644 index 0000000..f403231 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/package-use.html @@ -0,0 +1,169 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.repo.sleepycat (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="Uses of Package com.amazon.carbonado.repo.sleepycat (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.repo.sleepycat" class="title">Uses of Package<br>com.amazon.carbonado.repo.sleepycat</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> used by <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/class-use/BDBPanicHandler.html#com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> +<div class="block">Interface for a generic panic handler for any BDB products.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/class-use/BDBProduct.html#com.amazon.carbonado.repo.sleepycat">BDBProduct</a> +<div class="block">Set of supported BDB products.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/class-use/BDBRepositoryBuilder.DatabaseHook.html#com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/class-use/CompactionCapability.Result.html#com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../com/amazon/carbonado/repo/sleepycat/class-use/HotBackupCapability.Backup.html#com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html b/apidocs/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html new file mode 100644 index 0000000..eb8eeb8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html @@ -0,0 +1,363 @@ +<!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>AbstractSequenceValueProducer (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="AbstractSequenceValueProducer (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/AbstractSequenceValueProducer.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" target="_top">Frames</a></li> +<li><a href="AbstractSequenceValueProducer.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><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.sequence</div> +<h2 title="Class AbstractSequenceValueProducer" class="title">Class AbstractSequenceValueProducer</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.sequence.AbstractSequenceValueProducer</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/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractSequenceValueProducer</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></pre> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#AbstractSequenceValueProducer()">AbstractSequenceValueProducer</a></strong>()</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextDecimalValue()">nextDecimalValue</a></strong>()</code> +<div class="block">Returns the next decimal string value from the sequence, which remains + positive.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextIntValue()">nextIntValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</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/sequence/AbstractSequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue</a></strong>(int radix, + int minLength)</code> +<div class="block">Returns the next numerical string value from the sequence, which remains + positive.</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.sequence.SequenceValueProducer"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></h3> +<code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextLongValue()">nextLongValue</a>, <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#returnReservedValues()">returnReservedValues</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="AbstractSequenceValueProducer()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractSequenceValueProducer</h4> +<pre>protected AbstractSequenceValueProducer()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="nextIntValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextIntValue</h4> +<pre>public int nextIntValue() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextIntValue()">SequenceValueProducer</a></code></strong></div> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextIntValue()">nextIntValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></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> - for fetch/persist failure or if sequence is + exhausted for int values.</dd></dl> +</li> +</ul> +<a name="nextDecimalValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextDecimalValue</h4> +<pre>public java.lang.String nextDecimalValue() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextDecimalValue()">SequenceValueProducer</a></code></strong></div> +<div class="block">Returns the next decimal string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextDecimalValue()">nextDecimalValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></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> - for fetch/persist failure or if sequence is exhausted.</dd></dl> +</li> +</ul> +<a name="nextNumericalValue(int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>nextNumericalValue</h4> +<pre>public java.lang.String nextNumericalValue(int radix, + int minLength) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextNumericalValue(int, int)">SequenceValueProducer</a></code></strong></div> +<div class="block">Returns the next numerical string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>radix</code> - use 2 for binary, 10 for decimal, 16 for hex. Max is 36.</dd><dd><code>minLength</code> - ensure string is at least this long (padded with zeros if + necessary) to ensure proper string sort</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> - for fetch/persist failure or if sequence is exhausted.</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/AbstractSequenceValueProducer.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" target="_top">Frames</a></li> +<li><a href="AbstractSequenceValueProducer.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><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> diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceCapability.html b/apidocs/com/amazon/carbonado/sequence/SequenceCapability.html new file mode 100644 index 0000000..8da69eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/SequenceCapability.html @@ -0,0 +1,229 @@ +<!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>SequenceCapability (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="SequenceCapability (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/SequenceCapability.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/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceCapability.html" target="_top">Frames</a></li> +<li><a href="SequenceCapability.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.sequence</div> +<h2 title="Interface SequenceCapability" class="title">Interface SequenceCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">SequenceCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability to use sequences.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>bcastill</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><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +</td> +</tr> +</table> +</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="getSequenceValueProducer(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSequenceValueProducer</h4> +<pre><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> getSequenceValueProducer(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - sequence name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/SequenceCapability.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/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceCapability.html" target="_top">Frames</a></li> +<li><a href="SequenceCapability.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> diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html b/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html new file mode 100644 index 0000000..d4dd7a4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/SequenceValueGenerator.html @@ -0,0 +1,512 @@ +<!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>SequenceValueGenerator (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="SequenceValueGenerator (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/SequenceValueGenerator.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/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceValueGenerator.html" target="_top">Frames</a></li> +<li><a href="SequenceValueGenerator.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.sequence</div> +<h2 title="Class SequenceValueGenerator" class="title">Class SequenceValueGenerator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">com.amazon.carbonado.sequence.AbstractSequenceValueProducer</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.sequence.SequenceValueGenerator</li> +</ul> +</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/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SequenceValueGenerator</span> +extends <a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></pre> +<div class="block">General purpose implementation of a sequence value generator.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, bcastill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a>, +<a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_INCREMENT">DEFAULT_INCREMENT</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_INITIAL_VALUE">DEFAULT_INITIAL_VALUE</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_RESERVE_AMOUNT">DEFAULT_RESERVE_AMOUNT</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/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name, + long initialValue, + int increment)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int, int)">SequenceValueGenerator</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name, + long initialValue, + int increment, + int reserveAmount)</code> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#nextIntValue()">nextIntValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#nextLongValue()">nextLongValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#reset(int)">reset</a></strong>(int initialValue)</code> +<div class="block">Reset the sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html#returnReservedValues()">returnReservedValues</a></strong>()</code> +<div class="block">Allow any unused reserved values to be returned for re-use.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.sequence.AbstractSequenceValueProducer"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></h3> +<code><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextDecimalValue()">nextDecimalValue</a>, <a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue</a></code></li> +</ul> +<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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEFAULT_RESERVE_AMOUNT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_RESERVE_AMOUNT</h4> +<pre>public static final int DEFAULT_RESERVE_AMOUNT</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.sequence.SequenceValueGenerator.DEFAULT_RESERVE_AMOUNT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DEFAULT_INITIAL_VALUE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_INITIAL_VALUE</h4> +<pre>public static final int DEFAULT_INITIAL_VALUE</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.sequence.SequenceValueGenerator.DEFAULT_INITIAL_VALUE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DEFAULT_INCREMENT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_INCREMENT</h4> +<pre>public static final int DEFAULT_INCREMENT</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.amazon.carbonado.sequence.SequenceValueGenerator.DEFAULT_INCREMENT">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SequenceValueGenerator</h4> +<pre>public SequenceValueGenerator(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist. The initial sequence value is one, + and the increment is one.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - repository to persist sequence data</dd><dd><code>name</code> - name of sequence</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SequenceValueGenerator</h4> +<pre>public SequenceValueGenerator(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name, + long initialValue, + int increment) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - repository to persist sequence data</dd><dd><code>name</code> - name of sequence</dd><dd><code>initialValue</code> - initial sequence value, if sequence needs to be created</dd><dd><code>increment</code> - amount to increment sequence by</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SequenceValueGenerator</h4> +<pre>public SequenceValueGenerator(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.String name, + long initialValue, + int increment, + int reserveAmount) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - repository to persist sequence data</dd><dd><code>name</code> - name of sequence</dd><dd><code>initialValue</code> - initial sequence value, if sequence needs to be created</dd><dd><code>increment</code> - amount to increment sequence by</dd><dd><code>reserveAmount</code> - amount of sequence values to reserve</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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="reset(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>public void reset(int initialValue) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Reset the sequence.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialValue</code> - first value produced by sequence</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> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="nextLongValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextLongValue</h4> +<pre>public long nextLongValue() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</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> - for fetch/persist failure or if sequence is exhausted.</dd></dl> +</li> +</ul> +<a name="nextIntValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextIntValue</h4> +<pre>public int nextIntValue() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextIntValue()">nextIntValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextIntValue()">nextIntValue</a></code> in class <code><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></code></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> - for fetch/persist failure or if sequence is + exhausted for int values.</dd></dl> +</li> +</ul> +<a name="returnReservedValues()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>returnReservedValues</h4> +<pre>public boolean returnReservedValues() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Allow any unused reserved values to be returned for re-use. If the + repository is shared by other processes, then reserved values might not + be returnable. + + <p>This method should be called during the shutdown process of a + repository, although calling it does not invalidate this + SequenceValueGenerator. If getNextValue is called again, it will reserve + values again.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if reserved values were returned</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> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</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/SequenceValueGenerator.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/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceValueGenerator.html" target="_top">Frames</a></li> +<li><a href="SequenceValueGenerator.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceValueProducer.html b/apidocs/com/amazon/carbonado/sequence/SequenceValueProducer.html new file mode 100644 index 0000000..44213bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/SequenceValueProducer.html @@ -0,0 +1,345 @@ +<!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>SequenceValueProducer (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="SequenceValueProducer (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/SequenceValueProducer.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/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceValueProducer.html" target="_top">Frames</a></li> +<li><a href="SequenceValueProducer.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.sequence</div> +<h2 title="Interface SequenceValueProducer" class="title">Interface SequenceValueProducer</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a>, <a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">SequenceValueProducer</span></pre> +<div class="block">Produces values for sequences.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, bcastill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a></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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextDecimalValue()">nextDecimalValue</a></strong>()</code> +<div class="block">Returns the next decimal string value from the sequence, which remains + positive.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextIntValue()">nextIntValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextLongValue()">nextLongValue</a></strong>()</code> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</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/sequence/SequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue</a></strong>(int radix, + int minLength)</code> +<div class="block">Returns the next numerical string value from the sequence, which remains + positive.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html#returnReservedValues()">returnReservedValues</a></strong>()</code> +<div class="block">Allow any unused reserved values to be returned for re-use.</div> +</td> +</tr> +</table> +</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="nextLongValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextLongValue</h4> +<pre>long nextLongValue() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</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> - for fetch/persist failure or if sequence is exhausted.</dd></dl> +</li> +</ul> +<a name="nextIntValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextIntValue</h4> +<pre>int nextIntValue() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted. When sequence wraps back to initial + value, the sequence is fully exhausted, and an exception is thrown to + indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</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> - for fetch/persist failure or if sequence is + exhausted for int values.</dd></dl> +</li> +</ul> +<a name="nextDecimalValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextDecimalValue</h4> +<pre>java.lang.String nextDecimalValue() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the next decimal string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</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> - for fetch/persist failure or if sequence is exhausted.</dd></dl> +</li> +</ul> +<a name="nextNumericalValue(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nextNumericalValue</h4> +<pre>java.lang.String nextNumericalValue(int radix, + int minLength) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns the next numerical string value from the sequence, which remains + positive. When sequence wraps back to initial value, the sequence is + fully exhausted, and an exception is thrown to indicate this. + + <p>Note: this method throws PersistException even for fetch failures + since this method is called by insert operations. Insert operations can + only throw a PersistException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>radix</code> - use 2 for binary, 10 for decimal, 16 for hex. Max is 36.</dd><dd><code>minLength</code> - ensure string is at least this long (padded with zeros if + necessary) to ensure proper string sort</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> - for fetch/persist failure or if sequence is exhausted.</dd></dl> +</li> +</ul> +<a name="returnReservedValues()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>returnReservedValues</h4> +<pre>boolean returnReservedValues() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a>, + <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Allow any unused reserved values to be returned for re-use. If the + repository is shared by other processes, then reserved values might not + be returnable. + + <p>This method should be called during the shutdown process of a + repository, although calling it does not invalidate this + SequenceValueGenerator. If getNextValue is called again, it will reserve + values again.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if reserved values were returned</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> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</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/SequenceValueProducer.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/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceValueProducer.html" target="_top">Frames</a></li> +<li><a href="SequenceValueProducer.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> diff --git a/apidocs/com/amazon/carbonado/sequence/SequenceValueProducerPool.html b/apidocs/com/amazon/carbonado/sequence/SequenceValueProducerPool.html new file mode 100644 index 0000000..175ff58 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/SequenceValueProducerPool.html @@ -0,0 +1,347 @@ +<!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>SequenceValueProducerPool (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="SequenceValueProducerPool (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/SequenceValueProducerPool.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/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceValueProducerPool.html" target="_top">Frames</a></li> +<li><a href="SequenceValueProducerPool.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><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.sequence</div> +<h2 title="Class SequenceValueProducerPool" class="title">Class SequenceValueProducerPool</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.AbstractPool</a><java.lang.String,<a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.sequence.SequenceValueProducerPool</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">SequenceValueProducerPool</span> +extends <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a><java.lang.String,<a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></pre> +<div class="block">A concurrent pool of strongly referenced <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceValueProducer</code></a> + instances mapped by name. SequenceValueProducer instances are lazily created + and pooled.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">Author:</span></dt> + <dd>bcastill, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/sequence/SequenceValueProducerPool.html#SequenceValueProducerPool()">SequenceValueProducerPool</a></strong>()</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>protected <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#create(java.lang.String)">create</a></strong>(java.lang.String name)</code> +<div class="block">Return a new value instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#get(java.lang.String)">get</a></strong>(java.lang.String name)</code> +<div class="block">Returns a SequenceValueProducer instance for the given name, which is + lazily created and pooled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#returnReservedValues(org.apache.commons.logging.Log)">returnReservedValues</a></strong>(org.apache.commons.logging.Log log)</code> +<div class="block">Returns reserved values for all <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceValueProducer</code></a>s.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.AbstractPool"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#clear()">clear</a>, <a href="../../../../com/amazon/carbonado/util/AbstractPool.html#remove(java.lang.Object)">remove</a>, <a href="../../../../com/amazon/carbonado/util/AbstractPool.html#values()">values</a></code></li> +</ul> +<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> +</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="SequenceValueProducerPool()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SequenceValueProducerPool</h4> +<pre>public SequenceValueProducerPool()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="get(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> get(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns a SequenceValueProducer instance for the given name, which is + lazily created and pooled. If multiple threads are requesting upon the + same name concurrently, at most one thread attempts to lazily create the + SequenceValueProducer. The others wait for it to become available.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#get(K)">get</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a><java.lang.String,<a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name of sequence</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="returnReservedValues(org.apache.commons.logging.Log)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>returnReservedValues</h4> +<pre>public void returnReservedValues(org.apache.commons.logging.Log log)</pre> +<div class="block">Returns reserved values for all <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceValueProducer</code></a>s.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - optional log to report errors; uses default log if null</dd></dl> +</li> +</ul> +<a name="create(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>protected final <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> create(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#create(K)">AbstractPool</a></code></strong></div> +<div class="block">Return a new value instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#create(K)">create</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a><java.lang.String,<a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="createSequenceValueProducer(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSequenceValueProducer</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> createSequenceValueProducer(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/SequenceValueProducerPool.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/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/SequenceValueProducerPool.html" target="_top">Frames</a></li> +<li><a href="SequenceValueProducerPool.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><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> diff --git a/apidocs/com/amazon/carbonado/sequence/StoredSequence.html b/apidocs/com/amazon/carbonado/sequence/StoredSequence.html new file mode 100644 index 0000000..c507bda --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/StoredSequence.html @@ -0,0 +1,343 @@ +<!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>StoredSequence (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="StoredSequence (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/StoredSequence.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/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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.sequence</div> +<h2 title="Interface StoredSequence" class="title">Interface StoredSequence</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/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</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>="name") +<a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">@Authoritative</a> +<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_SEQUENCE","Carbonado_Sequence","carbonado_sequence","CarbonadoSequence","carbonadoSequence"}) +public interface <span class="strong">StoredSequence</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a>></pre> +<div class="block">Stores data for <a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><code>SequenceValueGenerator</code></a>. To use with JDBC repository, + create a table like so: + + <pre> + CREATE TABLE CARBONADO_SEQUENCE ( + NAME VARCHAR(100) PRIMARY KEY, + INITIAL_VALUE BIGINT NOT NULL, + NEXT_VALUE BIGINT NOT NULL, + VERSION INT NOT NULL + ) + </pre></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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/sequence/StoredSequence.html#getInitialValue()">getInitialValue</a></strong>()</code> +<div class="block">Returns the initial value for the sequence.</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/sequence/StoredSequence.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#getNextValue()">getNextValue</a></strong>()</code> +<div class="block">Returns the pre-adjusted next value of the sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#setInitialValue(long)">setInitialValue</a></strong>(long value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#setName(java.lang.String)">setName</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/sequence/StoredSequence.html#setNextValue(long)">setNextValue</a></strong>(long value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html#setVersion(int)">setVersion</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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre><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>={"NAME","Name","name"}) +java.lang.String getName()</pre> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>void setName(java.lang.String name)</pre> +</li> +</ul> +<a name="getInitialValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialValue</h4> +<pre><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>={"INITIAL_VALUE","Initial_Value","initial_value","InitialValue","initialValue"}) +long getInitialValue()</pre> +<div class="block">Returns the initial value for the sequence.</div> +</li> +</ul> +<a name="setInitialValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitialValue</h4> +<pre>void setInitialValue(long value)</pre> +</li> +</ul> +<a name="getNextValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextValue</h4> +<pre><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>={"NEXT_VALUE","Next_Value","next_value","NextValue","nextValue"}) +long getNextValue()</pre> +<div class="block">Returns the pre-adjusted next value of the sequence. This value is + initially Long.MIN_VALUE, and it increments up to Long.MAX_VALUE. The actual + next value for the sequence is: (getNextValue() + Long.MIN_VALUE + getInitialValue()).</div> +</li> +</ul> +<a name="setNextValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNextValue</h4> +<pre>void setNextValue(long value)</pre> +</li> +</ul> +<a name="getVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersion</h4> +<pre><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>={"VERSION","Version","version"}) +<a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +int getVersion()</pre> +</li> +</ul> +<a name="setVersion(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setVersion</h4> +<pre>void setVersion(int version)</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/StoredSequence.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/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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> diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html b/apidocs/com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html new file mode 100644 index 0000000..b8b2ec5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.sequence.AbstractSequenceValueProducer (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="Uses of Class com.amazon.carbonado.sequence.AbstractSequenceValueProducer (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><a href="../../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html" target="_top">Frames</a></li> +<li><a href="AbstractSequenceValueProducer.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"> +<h2 title="Uses of Class com.amazon.carbonado.sequence.AbstractSequenceValueProducer" class="title">Uses of Class<br>com.amazon.carbonado.sequence.AbstractSequenceValueProducer</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></strong></code> +<div class="block">General purpose implementation of a sequence value generator.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html" target="_top">Frames</a></li> +<li><a href="AbstractSequenceValueProducer.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> diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/SequenceCapability.html b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceCapability.html new file mode 100644 index 0000000..6e45c69 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceCapability.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.sequence.SequenceCapability (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="Uses of Interface com.amazon.carbonado.sequence.SequenceCapability (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><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/SequenceCapability.html" target="_top">Frames</a></li> +<li><a href="SequenceCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.sequence.SequenceCapability" class="title">Uses of Interface<br>com.amazon.carbonado.sequence.SequenceCapability</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a><Txn></strong></code> +<div class="block">Implements basic functionality required by a core Repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/SequenceCapability.html" target="_top">Frames</a></li> +<li><a href="SequenceCapability.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> diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html new file mode 100644 index 0000000..0884b62 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.sequence.SequenceValueGenerator (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="Uses of Class com.amazon.carbonado.sequence.SequenceValueGenerator (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><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html" target="_top">Frames</a></li> +<li><a href="SequenceValueGenerator.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"> +<h2 title="Uses of Class com.amazon.carbonado.sequence.SequenceValueGenerator" class="title">Uses of Class<br>com.amazon.carbonado.sequence.SequenceValueGenerator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.sequence.SequenceValueGenerator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/SequenceValueGenerator.html" target="_top">Frames</a></li> +<li><a href="SequenceValueGenerator.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> diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html new file mode 100644 index 0000000..889f7fa --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html @@ -0,0 +1,264 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.sequence.SequenceValueProducer (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="Uses of Interface com.amazon.carbonado.sequence.SequenceValueProducer (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><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html" target="_top">Frames</a></li> +<li><a href="SequenceValueProducer.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"> +<h2 title="Uses of Interface com.amazon.carbonado.sequence.SequenceValueProducer" class="title">Uses of Interface<br>com.amazon.carbonado.sequence.SequenceValueProducer</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> that return <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">MasterSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/gen/MasterSupport.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Returns a sequence value producer by name, or throw PersistException if not found.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> that implement <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></strong></code> +<div class="block">General purpose implementation of a sequence value generator.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> that return <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">SequenceValueProducerPool.</span><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#create(java.lang.String)">create</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">SequenceValueProducerPool.</span><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">SequenceValueProducerPool.</span><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#get(java.lang.String)">get</a></strong>(java.lang.String name)</code> +<div class="block">Returns a SequenceValueProducer instance for the given name, which is + lazily created and pooled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">SequenceCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Called upon to create a new SequenceValueProducer instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)">LobEngine</a></strong>(<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html" target="_top">Frames</a></li> +<li><a href="SequenceValueProducer.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> diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html new file mode 100644 index 0000000..5577303 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.sequence.SequenceValueProducerPool (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="Uses of Class com.amazon.carbonado.sequence.SequenceValueProducerPool (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><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html" target="_top">Frames</a></li> +<li><a href="SequenceValueProducerPool.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"> +<h2 title="Uses of Class com.amazon.carbonado.sequence.SequenceValueProducerPool" class="title">Uses of Class<br>com.amazon.carbonado.sequence.SequenceValueProducerPool</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.sequence.SequenceValueProducerPool</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/SequenceValueProducerPool.html" target="_top">Frames</a></li> +<li><a href="SequenceValueProducerPool.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> diff --git a/apidocs/com/amazon/carbonado/sequence/class-use/StoredSequence.html b/apidocs/com/amazon/carbonado/sequence/class-use/StoredSequence.html new file mode 100644 index 0000000..144e436 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/class-use/StoredSequence.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.sequence.StoredSequence (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="Uses of Interface com.amazon.carbonado.sequence.StoredSequence (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><a href="../../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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"> +<h2 title="Uses of Interface com.amazon.carbonado.sequence.StoredSequence" class="title">Uses of Interface<br>com.amazon.carbonado.sequence.StoredSequence</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.sequence.StoredSequence</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/sequence/class-use/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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> diff --git a/apidocs/com/amazon/carbonado/sequence/package-frame.html b/apidocs/com/amazon/carbonado/sequence/package-frame.html new file mode 100644 index 0000000..fb8fb71 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/package-frame.html @@ -0,0 +1,28 @@ +<!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.sequence (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/sequence/package-summary.html" target="classFrame">com.amazon.carbonado.sequence</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="SequenceCapability.html" title="interface in com.amazon.carbonado.sequence" target="classFrame"><i>SequenceCapability</i></a></li> +<li><a href="SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence" target="classFrame"><i>SequenceValueProducer</i></a></li> +<li><a href="StoredSequence.html" title="interface in com.amazon.carbonado.sequence" target="classFrame"><i>StoredSequence</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence" target="classFrame">AbstractSequenceValueProducer</a></li> +<li><a href="SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence" target="classFrame">SequenceValueGenerator</a></li> +<li><a href="SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence" target="classFrame">SequenceValueProducerPool</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/sequence/package-summary.html b/apidocs/com/amazon/carbonado/sequence/package-summary.html new file mode 100644 index 0000000..e7cc83a --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/package-summary.html @@ -0,0 +1,192 @@ +<!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.sequence (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.sequence (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><a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/spi/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/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.sequence</h1> +<div class="docSummary"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</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/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></td> +<td class="colLast"> +<div class="block">Capability to use sequences.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></td> +<td class="colLast"> +<div class="block">Produces values for sequences.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></td> +<td class="colLast"> +<div class="block">Stores data for <a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><code>SequenceValueGenerator</code></a>.</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/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></td> +<td class="colLast"> +<div class="block">General purpose implementation of a sequence value generator.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a></td> +<td class="colLast"> +<div class="block">A concurrent pool of strongly referenced <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceValueProducer</code></a> + instances mapped by name.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.sequence Description">Package com.amazon.carbonado.sequence Description</h2> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys. Most repository implementations support sequences already, but direct + control over sequences might be desired.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a></dd></dl> +</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><a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/spi/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/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> diff --git a/apidocs/com/amazon/carbonado/sequence/package-tree.html b/apidocs/com/amazon/carbonado/sequence/package-tree.html new file mode 100644 index 0000000..fbb84a4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/package-tree.html @@ -0,0 +1,153 @@ +<!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.sequence Class Hierarchy (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.sequence Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/sleepycat/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/spi/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.sequence</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util"><span class="strong">AbstractPool</span></a><K,V,E> +<ul> +<li type="circle">com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence"><span class="strong">SequenceValueProducerPool</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence"><span class="strong">AbstractSequenceValueProducer</span></a> (implements com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a>) +<ul> +<li type="circle">com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><span class="strong">SequenceValueGenerator</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">SequenceCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">SequenceValueProducer</span></a></li> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">StoredSequence</span></a></li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/sleepycat/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/spi/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/sequence/package-use.html b/apidocs/com/amazon/carbonado/sequence/package-use.html new file mode 100644 index 0000000..2ea8e3a --- /dev/null +++ b/apidocs/com/amazon/carbonado/sequence/package-use.html @@ -0,0 +1,209 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.sequence (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="Uses of Package com.amazon.carbonado.sequence (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.sequence" class="title">Uses of Package<br>com.amazon.carbonado.sequence</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.gen">com.amazon.carbonado.gen</a></td> +<td class="colLast"> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.gen"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> used by <a href="../../../../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html#com.amazon.carbonado.gen">SequenceValueProducer</a> +<div class="block">Produces values for sequences.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> used by <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/sequence/class-use/AbstractSequenceValueProducer.html#com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html#com.amazon.carbonado.sequence">SequenceValueProducer</a> +<div class="block">Produces values for sequences.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/sequence/class-use/SequenceCapability.html#com.amazon.carbonado.spi">SequenceCapability</a> +<div class="block">Capability to use sequences.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/sequence/class-use/SequenceValueProducer.html#com.amazon.carbonado.spi">SequenceValueProducer</a> +<div class="block">Produces values for sequences.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/sequence/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/spi/AbstractRepository.html b/apidocs/com/amazon/carbonado/spi/AbstractRepository.html new file mode 100644 index 0000000..1e5daa2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/AbstractRepository.html @@ -0,0 +1,759 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AbstractRepository (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="AbstractRepository (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/AbstractRepository.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/AbstractRepository.html" target="_top">Frames</a></li> +<li><a href="AbstractRepository.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><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.spi</div> +<h2 title="Class AbstractRepository" class="title">Class AbstractRepository<Txn></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.AbstractRepository<Txn></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>Txn</code> - Transaction type</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>, <a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a>, <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>, <a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractRepository<Txn></span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>, <a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a>, <a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></pre> +<div class="block">Implements basic functionality required by a core Repository.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#AbstractRepository(java.lang.String)">AbstractRepository</a></strong>(java.lang.String name)</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>protected java.util.Collection<<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#allStorage()">allStorage</a></strong>()</code> +<div class="block">Returns all available Storage instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#close()">close</a></strong>()</code> +<div class="block">Closes this repository reference, aborting any current + transactions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Called upon to create a new SequenceValueProducer instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Called upon to create a new Storage instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction()">enterTransaction</a></strong>()</code> +<div class="block">Causes the current thread to enter a transaction scope.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><C extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> <br>C</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getCapability(java.lang.Class)">getCapability</a></strong>(java.lang.Class<C> capabilityType)</code> +<div class="block">Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract org.apache.commons.logging.Log</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getLog()">getLog</a></strong>()</code> +<div class="block">Return the main Log object for this Repository.</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/spi/AbstractRepository.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of this repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></strong>(java.lang.String name)</code> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#isAutoShutdownEnabled()">isAutoShutdownEnabled</a></strong>()</code> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#isClosed()">isClosed</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#localTransactionScope()">localTransactionScope</a></strong>()</code> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#lockoutShutdown()">lockoutShutdown</a></strong>()</code> +<div class="block">Call to prevent shutdown hook from running.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled</a></strong>(boolean enabled)</code> +<div class="block">Request to enable or disable the automatic shutdown hook.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#shutdown()">shutdown</a></strong>()</code> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#shutdownHook()">shutdownHook</a></strong>()</code> +<div class="block">Install custom shutdown logic by overriding this method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#storageFor(java.lang.Class)">storageFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a><<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#transactionManager()">transactionManager</a></strong>()</code> +<div class="block">Returns the repository's TransactionManager.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html#unlockoutShutdown()">unlockoutShutdown</a></strong>()</code> +<div class="block">Only call this to release lockoutShutdown.</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> +</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="AbstractRepository(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractRepository</h4> +<pre>protected AbstractRepository(java.lang.String name)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#getName()">Repository</a></code></strong></div> +<div class="block">Returns the name of this repository.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#getName()">getName</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +</dl> +</li> +</ul> +<a name="storageFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>storageFor</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> storageFor(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">Repository</a></code></strong></div> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">storageFor</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>specific type of Storage instance</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 specified type cannot be supported</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if storage layer throws any other kind of + exception</dd></dl> +</li> +</ul> +<a name="enterTransaction()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTransaction</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTransaction()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()">Repository</a></code></strong></div> +<div class="block">Causes the current thread to enter a transaction scope. Call commit + inside the transaction in order for any updates to the repository to be + applied. Be sure to call exit when leaving the scope. + <p> + To ensure exit is called, use transactions as follows: + <pre> + Transaction txn = repository.enterTransaction(); + try { + // Make updates to storage layer + ... + + // Commit the changes up to this point + txn.commit(); + + // Optionally make more updates + ... + + // Commit remaining changes + txn.commit(); + } finally { + // Ensure transaction exits, aborting uncommitted changes if an exception was thrown + txn.exit(); + } + </pre></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()">enterTransaction</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +</dl> +</li> +</ul> +<a name="enterTransaction(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTransaction</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTransaction(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">Repository</a></code></strong></div> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level. The actual isolation level may be higher than + requested, if the repository does not support the exact level. If the + repository does not support a high enough level, it throws an + UnsupportedOperationException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - minimum desired transaction isolation level -- if null, a + suitable default is selected</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()"><code>Repository.enterTransaction()</code></a></dd></dl> +</li> +</ul> +<a name="enterTopTransaction(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTopTransaction</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTopTransaction(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">Repository</a></code></strong></div> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level. The actual isolation level may be + higher than requested, if the repository does not support the exact + level. If the repository does not support a high enough level, it throws + an UnsupportedOperationException. + + <p>This method requests a top-level transaction, which means it never + has a parent transaction, but it still can be a parent transaction + itself. This kind of transaction is useful when a commit must absolutely + succeed, even if the current thread is already in a transaction + scope. If there was a parent transaction, then a commit might still be + rolled back by the parent. + + <p>Requesting a top-level transaction can be deadlock prone if the + current thread is already in a transaction scope. The top-level + transaction may not be able to obtain locks held by the parent + transaction. An alternative to requesting top-level transactions is to + execute transactions in separate threads.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - minimum desired transaction isolation level -- if null, a + suitable default is selected</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Repository.html#enterTransaction()"><code>Repository.enterTransaction()</code></a></dd></dl> +</li> +</ul> +<a name="getTransactionIsolationLevel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionIsolationLevel</h4> +<pre>public <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> getTransactionIsolationLevel()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#getTransactionIsolationLevel()">Repository</a></code></strong></div> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +</dl> +</li> +</ul> +<a name="getCapability(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCapability</h4> +<pre>public <C extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a>> C getCapability(java.lang.Class<C> capabilityType)</pre> +<div class="block">Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)">getCapability</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>capabilityType</code> - type of capability requested</dd> +<dt><span class="strong">Returns:</span></dt><dd>capability instance or null if not supported</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Repository.html#close()">Repository</a></code></strong></div> +<div class="block">Closes this repository reference, aborting any current + transactions. Operations on objects returned by this repository will + fail when accessing the storage layer.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Repository.html#close()">close</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></dd> +</dl> +</li> +</ul> +<a name="isClosed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public boolean isClosed()</pre> +</li> +</ul> +<a name="isAutoShutdownEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutoShutdownEnabled</h4> +<pre>public boolean isAutoShutdownEnabled()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">ShutdownCapability</a></code></strong></div> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">isAutoShutdownEnabled</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></code></dd> +</dl> +</li> +</ul> +<a name="setAutoShutdownEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoShutdownEnabled</h4> +<pre>public void setAutoShutdownEnabled(boolean enabled)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#setAutoShutdownEnabled(boolean)">ShutdownCapability</a></code></strong></div> +<div class="block">Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></code></dd> +</dl> +</li> +</ul> +<a name="shutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>public void shutdown()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#shutdown()">ShutdownCapability</a></code></strong></div> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down. Calling + close may cause spurious exceptions to be thrown by other threads which + may be interacting with the repository. Shutdown tries to reduce these + exceptions from being thrown by effectively <i>suspending</i> any + threads which continue to interact with this repository. <b>For this + reason, this method should only ever be called during a virtual machine + shutdown.</b> + + <p>Repositories may choose to implement this method by simply calling + close. There is no guarantee that shutdown will reduce exceptions, and + it might not suspend any threads. Also, repositories that require proper + shutdown should automatically register runtime hooks, and so this method + usually doesn't need to be called manually.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#shutdown()">shutdown</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></code></dd> +</dl> +</li> +</ul> +<a name="getSequenceValueProducer(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSequenceValueProducer</h4> +<pre>public <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> getSequenceValueProducer(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">SequenceCapability</a></code></strong></div> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer</a></code> in interface <code><a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - sequence name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="transactionManager()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transactionManager</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a><<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>> transactionManager()</pre> +<div class="block">Returns the repository's TransactionManager.</div> +</li> +</ul> +<a name="localTransactionScope()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localTransactionScope</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>> localTransactionScope()</pre> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</li> +</ul> +<a name="lockoutShutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockoutShutdown</h4> +<pre>protected void lockoutShutdown()</pre> +<div class="block">Call to prevent shutdown hook from running. Be sure to call + unlockoutShutdown afterwards.</div> +</li> +</ul> +<a name="unlockoutShutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unlockoutShutdown</h4> +<pre>protected void unlockoutShutdown()</pre> +<div class="block">Only call this to release lockoutShutdown.</div> +</li> +</ul> +<a name="allStorage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allStorage</h4> +<pre>protected java.util.Collection<<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>> allStorage()</pre> +<div class="block">Returns all available Storage instances.</div> +</li> +</ul> +<a name="shutdownHook()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shutdownHook</h4> +<pre>protected void shutdownHook()</pre> +<div class="block">Install custom shutdown logic by overriding this method. By default it + does nothing.</div> +</li> +</ul> +<a name="getLog()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLog</h4> +<pre>protected abstract org.apache.commons.logging.Log getLog()</pre> +<div class="block">Return the main Log object for this Repository. If none provided, then + no messages are logged by AbstractRepository.</div> +</li> +</ul> +<a name="createStorage(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStorage</h4> +<pre>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> createStorage(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Called upon to create a new Storage instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="createSequenceValueProducer(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createSequenceValueProducer</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> createSequenceValueProducer(java.lang.String name) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Called upon to create a new SequenceValueProducer instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/AbstractRepository.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/AbstractRepository.html" target="_top">Frames</a></li> +<li><a href="AbstractRepository.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html b/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html new file mode 100644 index 0000000..80d38d6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/AbstractRepositoryBuilder.html @@ -0,0 +1,405 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AbstractRepositoryBuilder (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="AbstractRepositoryBuilder (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/AbstractRepositoryBuilder.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/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="AbstractRepositoryBuilder.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><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.spi</div> +<h2 title="Class AbstractRepositoryBuilder" class="title">Class AbstractRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.AbstractRepositoryBuilder</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/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a>, <a href="../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractRepositoryBuilder</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></pre> +<div class="block">Abstract builder class for opening repositories.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#AbstractRepositoryBuilder()">AbstractRepositoryBuilder</a></strong>()</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a></strong>(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> +<div class="block">Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a></strong>()</code> +<div class="block">Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a></strong>()</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a></strong>()</code> +<div class="block">Returns all the TriggerFactories which were added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></strong>(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</code> +<div class="block">Remove a TriggerFactory which was added earlier.</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.RepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></h3> +<code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a>, <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">getName</a>, <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">isMaster</a>, <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">setMaster</a>, <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">setName</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="AbstractRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractRepositoryBuilder</h4> +<pre>protected AbstractRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build() + throws <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build()">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#build()">build</a></code> in interface <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="addTriggerFactory(com.amazon.carbonado.TriggerFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTriggerFactory</h4> +<pre>public boolean addTriggerFactory(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">RepositoryBuilder</a></code></strong></div> +<div class="block">Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports. The + primary purpose of this method is to allow decorator repositories the + opportunity to register custom persistence code for each Storable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a></code> in interface <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if TriggerFactory was added, false if TriggerFactory was + not added because an equal TriggerFactory is already registered</dd></dl> +</li> +</ul> +<a name="removeTriggerFactory(com.amazon.carbonado.TriggerFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeTriggerFactory</h4> +<pre>public boolean removeTriggerFactory(<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a> factory)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">RepositoryBuilder</a></code></strong></div> +<div class="block">Remove a TriggerFactory which was added earlier.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code> in interface <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>true if TriggerFactory instance was removed, false if not added</dd></dl> +</li> +</ul> +<a name="getTriggerFactories()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTriggerFactories</h4> +<pre>public java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> getTriggerFactories()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#getTriggerFactories()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns all the TriggerFactories which were added.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a></code> in interface <code><a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></dd> +</dl> +</li> +</ul> +<a name="assertReady()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>assertReady</h4> +<pre>public final void assertReady() + throws <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block">Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code></dd></dl> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/AbstractRepositoryBuilder.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/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="AbstractRepositoryBuilder.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html b/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html new file mode 100644 index 0000000..4849f11 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/BelatedRepositoryCreator.html @@ -0,0 +1,361 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>BelatedRepositoryCreator (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="BelatedRepositoryCreator (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/BelatedRepositoryCreator.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/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/BelatedRepositoryCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedRepositoryCreator.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><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.spi</div> +<h2 title="Class BelatedRepositoryCreator" class="title">Class BelatedRepositoryCreator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.BelatedRepositoryCreator</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">BelatedRepositoryCreator</span> +extends <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></pre> +<div class="block">Generic one-shot Repository builder which supports late object creation. If + the Repository building results in an exception or is taking too long, the + Repository produced instead is a bogus one. Many operations result in an + IllegalStateException. After retrying, if the real Repository is created, + then the bogus Repository turns into a wrapper to the real Repository.</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/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><code>BelatedStorageCreator</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef, + int minRetryDelayMillis)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, int)">BelatedRepositoryCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + int minRetryDelayMillis)</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>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createBogus()">createBogus</a></strong>()</code> +<div class="block">Create instance of bogus object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createReal()">createReal</a></strong>()</code> +<div class="block">Create instance of real object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#timedOutNotification(long)">timedOutNotification</a></strong>(long timedOutMillis)</code> +<div class="block">Notification that createReal is taking too long.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.BelatedCreator"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createdNotification(T)">createdNotification</a>, <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#get(int)">get</a></code></li> +</ul> +<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> +</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="BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BelatedRepositoryCreator</h4> +<pre>public BelatedRepositoryCreator(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + int minRetryDelayMillis)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - error reporting log</dd><dd><code>builder</code> - builds real Repository</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry</dd></dl> +</li> +</ul> +<a name="BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BelatedRepositoryCreator</h4> +<pre>public BelatedRepositoryCreator(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> builder, + java.util.concurrent.atomic.AtomicReference<<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef, + int minRetryDelayMillis)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - error reporting log</dd><dd><code>builder</code> - builds real Repository</dd><dd><code>rootRef</code> - reference to root repository</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry</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="createReal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createReal</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> createReal() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">BelatedCreator</a></code></strong></div> +<div class="block">Create instance of real object. If there is a recoverable error creating + the object, return null. Any error logging must be performed by the + implementation of this method. If null is returned, expect this method + to be called again in the future.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">createReal</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>real object, or null if there was a recoverable error</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></dd></dl> +</li> +</ul> +<a name="createBogus()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createBogus</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> createBogus()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">BelatedCreator</a></code></strong></div> +<div class="block">Create instance of bogus object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">createBogus</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +</dl> +</li> +</ul> +<a name="timedOutNotification(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>timedOutNotification</h4> +<pre>protected void timedOutNotification(long timedOutMillis)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">BelatedCreator</a></code></strong></div> +<div class="block">Notification that createReal is taking too long. This can be used to log + a message.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">timedOutNotification</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timedOutMillis</code> - milliseconds waited before giving up</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/BelatedRepositoryCreator.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/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/BelatedRepositoryCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedRepositoryCreator.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html b/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html new file mode 100644 index 0000000..8981984 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/BelatedStorageCreator.html @@ -0,0 +1,343 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>BelatedStorageCreator (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="BelatedStorageCreator (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/BelatedStorageCreator.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/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/BelatedStorageCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedStorageCreator.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><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.spi</div> +<h2 title="Class BelatedStorageCreator" class="title">Class BelatedStorageCreator<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><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.BelatedStorageCreator<S></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">BelatedStorageCreator<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></pre> +<div class="block">Generic one-shot Storage creator which supports late object creation. If + getting the Storage results in an exception or is taking too long, the + Storage produced instead is a bogus one. Many operations result in an + IllegalStateException. After retrying, if the real Storage is accessed, then + the bogus Storage turns into a wrapper to the real Storage.</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/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><code>BelatedRepositoryCreator</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/spi/BelatedStorageCreator.html#BelatedStorageCreator(org.apache.commons.logging.Log, com.amazon.carbonado.Repository, java.lang.Class, int)">BelatedStorageCreator</a></strong>(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> storableType, + int minRetryDelayMillis)</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>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#createBogus()">createBogus</a></strong>()</code> +<div class="block">Create instance of bogus object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#createReal()">createReal</a></strong>()</code> +<div class="block">Create instance of real object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html#timedOutNotification(long)">timedOutNotification</a></strong>(long timedOutMillis)</code> +<div class="block">Notification that createReal is taking too long.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.BelatedCreator"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createdNotification(T)">createdNotification</a>, <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#get(int)">get</a></code></li> +</ul> +<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> +</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="BelatedStorageCreator(org.apache.commons.logging.Log, com.amazon.carbonado.Repository, java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BelatedStorageCreator</h4> +<pre>public BelatedStorageCreator(org.apache.commons.logging.Log log, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo, + java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> storableType, + int minRetryDelayMillis)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - error reporting log</dd><dd><code>repo</code> - Repository to get Storage from</dd><dd><code>storableType</code> - type of Storable to get Storage for</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry</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="createReal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createReal</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> createReal() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">BelatedCreator</a></code></strong></div> +<div class="block">Create instance of real object. If there is a recoverable error creating + the object, return null. Any error logging must be performed by the + implementation of this method. If null is returned, expect this method + to be called again in the future.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">createReal</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>real object, or null if there was a recoverable error</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></dd></dl> +</li> +</ul> +<a name="createBogus()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createBogus</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a>> createBogus()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">BelatedCreator</a></code></strong></div> +<div class="block">Create instance of bogus object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">createBogus</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +</dl> +</li> +</ul> +<a name="timedOutNotification(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>timedOutNotification</h4> +<pre>protected void timedOutNotification(long timedOutMillis)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">BelatedCreator</a></code></strong></div> +<div class="block">Notification that createReal is taking too long. This can be used to log + a message.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">timedOutNotification</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a> extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>>,<a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timedOutMillis</code> - milliseconds waited before giving up</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/BelatedStorageCreator.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/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/BelatedStorageCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedStorageCreator.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html b/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html new file mode 100644 index 0000000..c1966eb --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/ExceptionTransformer.html @@ -0,0 +1,387 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ExceptionTransformer (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="ExceptionTransformer (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/ExceptionTransformer.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/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/ExceptionTransformer.html" target="_top">Frames</a></li> +<li><a href="ExceptionTransformer.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><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.spi</div> +<h2 title="Class ExceptionTransformer" class="title">Class ExceptionTransformer</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.ExceptionTransformer</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ExceptionTransformer</span> +extends java.lang.Object</pre> +<div class="block">Supports transforming arbitrary exceptions into appropriate repository + exceptions. Repositories will likely extend this class, providing custom + transformation rules.</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"> +<!-- ======== 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/spi/ExceptionTransformer.html#ExceptionTransformer()">ExceptionTransformer</a></strong>()</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>static <a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#getInstance()">getInstance</a></strong>()</code> +<div class="block">Returns a generic instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toFetchException(java.lang.Throwable)">toFetchException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toPersistException(java.lang.Throwable)">toPersistException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#toRepositoryException(java.lang.Throwable)">toRepositoryException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate repository + exception.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoFetchException(java.lang.Throwable)">transformIntoFetchException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoPersistException(java.lang.Throwable)">transformIntoPersistException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoRepositoryException(java.lang.Throwable)">transformIntoRepositoryException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</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> +</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="ExceptionTransformer()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ExceptionTransformer</h4> +<pre>public ExceptionTransformer()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getInstance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInstance</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a> getInstance()</pre> +<div class="block">Returns a generic instance.</div> +</li> +</ul> +<a name="toFetchException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toFetchException</h4> +<pre>public <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> toFetchException(java.lang.Throwable e)</pre> +<div class="block">Transforms the given throwable into an appropriate fetch exception. If + it already is a fetch exception, it is simply casted.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>FetchException, never null</dd></dl> +</li> +</ul> +<a name="toPersistException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toPersistException</h4> +<pre>public <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> toPersistException(java.lang.Throwable e)</pre> +<div class="block">Transforms the given throwable into an appropriate persist exception. If + it already is a persist exception, it is simply casted.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>PersistException, never null</dd></dl> +</li> +</ul> +<a name="toRepositoryException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toRepositoryException</h4> +<pre>public <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> toRepositoryException(java.lang.Throwable e)</pre> +<div class="block">Transforms the given throwable into an appropriate repository + exception. If it already is a repository exception, it is simply casted.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>RepositoryException, never null</dd></dl> +</li> +</ul> +<a name="transformIntoFetchException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transformIntoFetchException</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> transformIntoFetchException(java.lang.Throwable e)</pre> +<div class="block">Override to support custom transformations, returning null if none is + applicable. Be sure to call super first. If it returns non-null, return + that result.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>FetchException, or null if no applicable transform</dd></dl> +</li> +</ul> +<a name="transformIntoPersistException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transformIntoPersistException</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> transformIntoPersistException(java.lang.Throwable e)</pre> +<div class="block">Override to support custom transformations, returning null if none is + applicable. Be sure to call super first. If it returns non-null, return + that result.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>PersistException, or null if no applicable transform</dd></dl> +</li> +</ul> +<a name="transformIntoRepositoryException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>transformIntoRepositoryException</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a> transformIntoRepositoryException(java.lang.Throwable e)</pre> +<div class="block">Override to support custom transformations, returning null if none is + applicable. Be sure to call super first. If it returns non-null, return + that result.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>RepositoryException, or null if no applicable transform</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/ExceptionTransformer.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/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/ExceptionTransformer.html" target="_top">Frames</a></li> +<li><a href="ExceptionTransformer.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html b/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html new file mode 100644 index 0000000..3e9f79a --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/IndexInfoImpl.html @@ -0,0 +1,393 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>IndexInfoImpl (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="IndexInfoImpl (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/IndexInfoImpl.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/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/IndexInfoImpl.html" target="_top">Frames</a></li> +<li><a href="IndexInfoImpl.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><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.spi</div> +<h2 title="Class IndexInfoImpl" class="title">Class IndexInfoImpl</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.IndexInfoImpl</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/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">IndexInfoImpl</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></pre> +<div class="block">Basic implementation of an <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</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"> +<!-- ======== 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/spi/IndexInfoImpl.html#IndexInfoImpl(java.lang.String, boolean, boolean, java.lang.String[], com.amazon.carbonado.info.Direction[])">IndexInfoImpl</a></strong>(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] propertyDirections)</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of this index, or null if not applicable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns the directions of all the properties in this index.</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/spi/IndexInfoImpl.html#getPropertyNames()">getPropertyNames</a></strong>()</code> +<div class="block">Returns the properties in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#isClustered()">isClustered</a></strong>()</code> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#isUnique()">isUnique</a></strong>()</code> +<div class="block">Returns true if index entries are unique.</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/spi/IndexInfoImpl.html#toString()">toString</a></strong>()</code> </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, wait, wait, wait</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="IndexInfoImpl(java.lang.String, boolean, boolean, java.lang.String[], com.amazon.carbonado.info.Direction[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IndexInfoImpl</h4> +<pre>public IndexInfoImpl(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] propertyDirections)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - optional name for index</dd><dd><code>unique</code> - true if index requires unique values</dd><dd><code>propertyNames</code> - required list of property names, must have at least + one name</dd><dd><code>propertyDirections</code> - optional property directions, may be null or + same length as property names array</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code></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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getName()">IndexInfo</a></code></strong></div> +<div class="block">Returns the name of this index, or null if not applicable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getName()">getName</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUnique</h4> +<pre>public boolean isUnique()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">IndexInfo</a></code></strong></div> +<div class="block">Returns true if index entries are unique.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">isUnique</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="isClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClustered</h4> +<pre>public boolean isClustered()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">IndexInfo</a></code></strong></div> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">isClustered</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getPropertyNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyNames</h4> +<pre>public java.lang.String[] getPropertyNames()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">IndexInfo</a></code></strong></div> +<div class="block">Returns the properties in this index. The array might be empty, but it + is never null. The array is a copy, and so it may be safely modified.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">getPropertyNames</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="getPropertyDirections()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyDirections</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] getPropertyDirections()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">IndexInfo</a></code></strong></div> +<div class="block">Returns the directions of all the properties in this index. The length + of the array matches the length returned by <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()"><code>IndexInfo.getPropertyNames()</code></a>. The array is a copy, and so it may be safely + modified.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections</a></code> in interface <code><a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/IndexInfoImpl.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/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/IndexInfoImpl.html" target="_top">Frames</a></li> +<li><a href="IndexInfoImpl.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/LobEngine.html b/apidocs/com/amazon/carbonado/spi/LobEngine.html new file mode 100644 index 0000000..c9dd1af --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/LobEngine.html @@ -0,0 +1,560 @@ +<!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>LobEngine (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="LobEngine (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/LobEngine.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/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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><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.spi</div> +<h2 title="Class LobEngine" class="title">Class LobEngine</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.LobEngine</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LobEngine</span> +extends java.lang.Object</pre> +<div class="block">Complete Lob support for repositories, although repository is responsible + for binding Lob properties to this engine. Lobs are referenced by locators, + which are non-zero long integers. A zero locator is equivalent to null.</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/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)"><code>getSupportTrigger(Class, int)</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> locatorRepo)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer)</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/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#createNewBlob(int)">createNewBlob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Blob whose length is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<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/spi/LobEngine.html#createNewClob(int)">createNewClob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Clob whose length is zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(com.amazon.carbonado.lob.Lob)">deleteLob</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(long)">deleteLob</a></strong>(long locator)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="altColor"> +<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/spi/LobEngine.html#getBlobValue(long)">getBlobValue</a></strong>(long locator)</code> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +</td> +</tr> +<tr class="rowColor"> +<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/spi/LobEngine.html#getClobValue(long)">getClobValue</a></strong>(long locator)</code> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getLocator(com.amazon.carbonado.lob.Lob)">getLocator</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)">getSupportTrigger</a></strong>(java.lang.Class<S> type, + int blockSize)</code> +<div class="block">Returns a Trigger for binding to this LobEngine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#hasLobs(java.lang.Class)">hasLobs</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(long locator, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, java.io.InputStream)">setBlobValue</a></strong>(long locator, + java.io.InputStream data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(long locator, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, java.io.Reader)">setClobValue</a></strong>(long locator, + java.io.Reader data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</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> +</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="LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LobEngine</h4> +<pre>public LobEngine(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> locatorRepo) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lobRepo</code> - storage for Lobs - should not be replicated</dd><dd><code>locatorRepo</code> - storage for producing unique values for Lob locators + - should be root repository</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LobEngine</h4> +<pre>public LobEngine(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lobRepo</code> - storage for Lobs - should not be replicated</dd><dd><code>locatorSequenceProducer</code> - source of unique values for Lob locators</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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="hasLobs(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasLobs</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> boolean hasLobs(java.lang.Class<S> type)</pre> +</li> +</ul> +<a name="createNewBlob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createNewBlob</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> createNewBlob(int blockSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a new Blob whose length is zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blockSize</code> - block size (in <i>bytes</i>) to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>new empty Blob</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="createNewClob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createNewClob</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> createNewClob(int blockSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a new Clob whose length is zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blockSize</code> - block size (in <i>bytes</i>) to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>new empty Clob</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="getLocator(com.amazon.carbonado.lob.Lob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public long getLocator(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</pre> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.ClassCastException</code> - if Lob is unrecognized</dd></dl> +</li> +</ul> +<a name="deleteLob(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteLob</h4> +<pre>public void deleteLob(long locator) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</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></dd></dl> +</li> +</ul> +<a name="deleteLob(com.amazon.carbonado.lob.Lob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteLob</h4> +<pre>public void deleteLob(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</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></dd></dl> +</li> +</ul> +<a name="getBlobValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlobValue</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> getBlobValue(long locator)</pre> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as returned by getLocator</dd> +<dt><span class="strong">Returns:</span></dt><dd>Blob value or null</dd></dl> +</li> +</ul> +<a name="getClobValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClobValue</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> getClobValue(long locator)</pre> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as returned by getLocator</dd> +<dt><span class="strong">Returns:</span></dt><dd>Clob value or null</dd></dl> +</li> +</ul> +<a name="setBlobValue(long, com.amazon.carbonado.lob.Blob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobValue</h4> +<pre>public void setBlobValue(long locator, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Blob, replacing anything that was there + before. Passing null deletes the Blob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewBlob</dd><dd><code>data</code> - source of data for Blob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setBlobValue(long, java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobValue</h4> +<pre>public void setBlobValue(long locator, + java.io.InputStream data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Blob, replacing anything that was there + before. Passing null deletes the Blob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewBlob</dd><dd><code>data</code> - source of data for Blob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setClobValue(long, com.amazon.carbonado.lob.Clob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClobValue</h4> +<pre>public void setClobValue(long locator, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Clob, replacing anything that was there + before. Passing null deletes the Clob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewClob</dd><dd><code>data</code> - source of data for Clob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setClobValue(long, java.io.Reader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClobValue</h4> +<pre>public void setClobValue(long locator, + java.io.Reader data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Clob, replacing anything that was there + before. Passing null deletes the Clob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewClob</dd><dd><code>data</code> - source of data for Clob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="getSupportTrigger(java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSupportTrigger</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S> getSupportTrigger(java.lang.Class<S> type, + int blockSize)</pre> +<div class="block">Returns a Trigger for binding to this LobEngine. Storage implementations + which use LobEngine must install this Trigger. Trigger instances are + cached, so subsequent calls for the same trigger return the same + instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable to create trigger for</dd><dd><code>blockSize</code> - block size to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>support trigger or null if storable type has no lob properties</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/LobEngine.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/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/RAFInputStream.html b/apidocs/com/amazon/carbonado/spi/RAFInputStream.html new file mode 100644 index 0000000..915be7b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RAFInputStream.html @@ -0,0 +1,370 @@ +<!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>RAFInputStream (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="RAFInputStream (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/RAFInputStream.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/spi/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/RAFInputStream.html" target="_top">Frames</a></li> +<li><a href="RAFInputStream.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><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.spi</div> +<h2 title="Class RAFInputStream" class="title">Class RAFInputStream</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.io.InputStream</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.RAFInputStream</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Closeable, java.lang.AutoCloseable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RAFInputStream</span> +extends java.io.InputStream</pre> +<div class="block">InputStream that wraps a RandomAccessFile. A stream can be obtained for a + RandomAccessFile by getting the file descriptor and creating a + FileInputStream on it. Problem is that FileInputStream has a finalizer that + closes the RandomAccessFile.</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"> +<!-- ======== 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/spi/RAFInputStream.html#RAFInputStream(java.io.RandomAccessFile)">RAFInputStream</a></strong>(java.io.RandomAccessFile raf)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#read()">read</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#read(byte[])">read</a></strong>(byte[] b)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#read(byte[], int, int)">read</a></strong>(byte[] b, + int offset, + int length)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html#skip(long)">skip</a></strong>(long n)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.io.InputStream"> +<!-- --> +</a> +<h3>Methods inherited from class java.io.InputStream</h3> +<code>available, mark, markSupported, reset</code></li> +</ul> +<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> +</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="RAFInputStream(java.io.RandomAccessFile)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RAFInputStream</h4> +<pre>public RAFInputStream(java.io.RandomAccessFile raf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="read()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public int read() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>read</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="read(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public int read(byte[] b) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>read</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="read(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public int read(byte[] b, + int offset, + int length) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>read</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="skip(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skip</h4> +<pre>public long skip(long n) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>skip</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>close</code> in class <code>java.io.InputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/RAFInputStream.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/spi/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/RAFInputStream.html" target="_top">Frames</a></li> +<li><a href="RAFInputStream.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html b/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html new file mode 100644 index 0000000..a23245e --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RAFOutputStream.html @@ -0,0 +1,351 @@ +<!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>RAFOutputStream (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="RAFOutputStream (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/RAFOutputStream.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/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/RAFOutputStream.html" target="_top">Frames</a></li> +<li><a href="RAFOutputStream.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><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.spi</div> +<h2 title="Class RAFOutputStream" class="title">Class RAFOutputStream</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.io.OutputStream</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.RAFOutputStream</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">RAFOutputStream</span> +extends java.io.OutputStream</pre> +<div class="block">OutputStream that wraps a RandomAccessFile. A stream can be obtained for a + RandomAccessFile by getting the file descriptor and creating a + FileOutputStream on it. Problem is that FileOutputStream has a finalizer + that closes the RandomAccessFile.</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"> +<!-- ======== 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/spi/RAFOutputStream.html#RAFOutputStream(java.io.RandomAccessFile)">RAFOutputStream</a></strong>(java.io.RandomAccessFile raf)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#write(byte[])">write</a></strong>(byte[] b)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#write(byte[], int, int)">write</a></strong>(byte[] b, + int offset, + int length)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html#write(int)">write</a></strong>(int b)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.io.OutputStream"> +<!-- --> +</a> +<h3>Methods inherited from class java.io.OutputStream</h3> +<code>flush</code></li> +</ul> +<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> +</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="RAFOutputStream(java.io.RandomAccessFile)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RAFOutputStream</h4> +<pre>public RAFOutputStream(java.io.RandomAccessFile raf)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="write(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(int b) + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>write</code> in class <code>java.io.OutputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="write(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(byte[] b) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>write</code> in class <code>java.io.OutputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="write(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(byte[] b, + int offset, + int length) + throws java.io.IOException</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>write</code> in class <code>java.io.OutputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>close</code> in class <code>java.io.OutputStream</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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/RAFOutputStream.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/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/RAFOutputStream.html" target="_top">Frames</a></li> +<li><a href="RAFOutputStream.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/RepairExecutor.html b/apidocs/com/amazon/carbonado/spi/RepairExecutor.html new file mode 100644 index 0000000..ed413da --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/RepairExecutor.html @@ -0,0 +1,271 @@ +<!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>RepairExecutor (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="RepairExecutor (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/RepairExecutor.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/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/RepairExecutor.html" target="_top">Frames</a></li> +<li><a href="RepairExecutor.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.spi</div> +<h2 title="Class RepairExecutor" class="title">Class RepairExecutor</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.RepairExecutor</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">RepairExecutor</span> +extends java.lang.Object</pre> +<div class="block">A convenience class for repositories to run dynamic repairs in separate + threads. When a repository detects a consistency error during a user + operation, it should not perform the repair in the same thread. + + <p>If the repair was initiated by an exception, but the original exception + is re-thrown, a transaction exit will rollback the repair! Executing the + repair in a separate thread allows it to wait until the transaction has + exited. + + <p>Other kinds of inconsistencies might be detected during cursor + iteration. The repair will need to acquire write locks, but the open cursor + might not allow that, resulting in deadlock. Executing the repair in a + separate thread allows it to wait until the cursor has released locks. + + <p>This class keeps thread-local references to single-threaded executors. In + other words, each user thread has at most one associated repair thread. Each + repair thread has a fixed size queue, and they exit when they are idle. If + the queue is full, newly added repair tasks are silently discarded. + + <p>The following system properties are supported: + + <ul> + <li>com.amazon.carbonado.spi.RepairExecutor.keepAliveSeconds (default is 10) + <li>com.amazon.carbonado.spi.RepairExecutor.queueSize (default is 10000) + </ul></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>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html#execute(java.lang.Runnable)">execute</a></strong>(java.lang.Runnable repair)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html#waitForRepairsToFinish(long)">waitForRepairsToFinish</a></strong>(long timeoutMillis)</code> +<div class="block">Waits for repairs that were executed from the current thread to finish.</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> +</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="execute(java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public static void execute(java.lang.Runnable repair)</pre> +</li> +</ul> +<a name="waitForRepairsToFinish(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>waitForRepairsToFinish</h4> +<pre>public static boolean waitForRepairsToFinish(long timeoutMillis) + throws java.lang.InterruptedException</pre> +<div class="block">Waits for repairs that were executed from the current thread to finish.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if all repairs are finished</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</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/RepairExecutor.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/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/RepairExecutor.html" target="_top">Frames</a></li> +<li><a href="RepairExecutor.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> diff --git a/apidocs/com/amazon/carbonado/spi/StoragePool.html b/apidocs/com/amazon/carbonado/spi/StoragePool.html new file mode 100644 index 0000000..67a4167 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoragePool.html @@ -0,0 +1,333 @@ +<!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>StoragePool (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="StoragePool (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/StoragePool.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/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/StoragePool.html" target="_top">Frames</a></li> +<li><a href="StoragePool.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><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.spi</div> +<h2 title="Class StoragePool" class="title">Class StoragePool</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.AbstractPool</a><java.lang.Class,<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.StoragePool</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">StoragePool</span> +extends <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a><java.lang.Class,<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></pre> +<div class="block">A concurrent pool of strongly referenced Storage instances mapped by + Storable type. Storage instances are lazily created and pooled.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- ======== 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/spi/StoragePool.html#StoragePool()">StoragePool</a></strong>()</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>protected <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#create(java.lang.Class)">create</a></strong>(java.lang.Class type)</code> +<div class="block">Return a new value instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#createStorage(java.lang.Class)">createStorage</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.AbstractPool"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#clear()">clear</a>, <a href="../../../../com/amazon/carbonado/util/AbstractPool.html#get(K)">get</a>, <a href="../../../../com/amazon/carbonado/util/AbstractPool.html#remove(java.lang.Object)">remove</a>, <a href="../../../../com/amazon/carbonado/util/AbstractPool.html#values()">values</a></code></li> +</ul> +<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> +</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="StoragePool()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StoragePool</h4> +<pre>public StoragePool()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStorage(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorage</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> getStorage(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a>, + <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled. If multiple threads are requesting upon the same type + concurrently, at most one thread attempts to lazily create the + Storage. The others wait for it to become available.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></code></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="create(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>protected final <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a> create(java.lang.Class type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#create(K)">AbstractPool</a></code></strong></div> +<div class="block">Return a new value instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#create(K)">create</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a><java.lang.Class,<a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a>,<a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a>></code></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></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="createStorage(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createStorage</h4> +<pre>protected abstract <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><S> createStorage(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a>, + <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><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></dd> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/StoragePool.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/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/StoragePool.html" target="_top">Frames</a></li> +<li><a href="StoragePool.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html b/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html new file mode 100644 index 0000000..3a20d54 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredLob.Block.html @@ -0,0 +1,373 @@ +<!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>StoredLob.Block (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="StoredLob.Block (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/StoredLob.Block.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/spi/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/StoredLob.Block.html" target="_top">Frames</a></li> +<li><a href="StoredLob.Block.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><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.spi</div> +<h2 title="Class StoredLob.Block" class="title">Class StoredLob.Block</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.StoredLob.Block</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/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</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>={"locator","+blockNumber"}) +public abstract static class <span class="strong">StoredLob.Block</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a>></pre> +<div class="block">Blocks stored here.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/spi/StoredLob.Block.html#StoredLob.Block()">StoredLob.Block</a></strong>()</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>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getBlockNumber()">getBlockNumber</a></strong>()</code> +<div class="block">First block number is logically zero, but subtract 0x80000000 to get + actual number.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getData()">getData</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getLocator()">getLocator</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#setBlockNumber(int)">setBlockNumber</a></strong>(int number)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#setData(byte[])">setData</a></strong>(byte[] data)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#setLocator(long)">setLocator</a></strong>(long locator)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html#setVersion(int)">setVersion</a></strong>(int version)</code> </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.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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StoredLob.Block()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StoredLob.Block</h4> +<pre>public StoredLob.Block()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public abstract long getLocator()</pre> +</li> +</ul> +<a name="setLocator(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLocator</h4> +<pre>public abstract void setLocator(long locator)</pre> +</li> +</ul> +<a name="getBlockNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlockNumber</h4> +<pre>public abstract int getBlockNumber()</pre> +<div class="block">First block number is logically zero, but subtract 0x80000000 to get + actual number. This effectively makes the block number unsigned.</div> +</li> +</ul> +<a name="setBlockNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlockNumber</h4> +<pre>public abstract void setBlockNumber(int number)</pre> +</li> +</ul> +<a name="getData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public abstract byte[] getData()</pre> +</li> +</ul> +<a name="setData(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public abstract void setData(byte[] data)</pre> +</li> +</ul> +<a name="getVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersion</h4> +<pre><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +public abstract int getVersion()</pre> +</li> +</ul> +<a name="setVersion(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setVersion</h4> +<pre>public abstract void setVersion(int version)</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/StoredLob.Block.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/spi/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/StoredLob.Block.html" target="_top">Frames</a></li> +<li><a href="StoredLob.Block.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><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> diff --git a/apidocs/com/amazon/carbonado/spi/StoredLob.html b/apidocs/com/amazon/carbonado/spi/StoredLob.html new file mode 100644 index 0000000..a42dc2c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredLob.html @@ -0,0 +1,425 @@ +<!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>StoredLob (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="StoredLob (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/StoredLob.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/spi/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/StoredLob.html" target="_top">Frames</a></li> +<li><a href="StoredLob.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.spi</div> +<h2 title="Class StoredLob" class="title">Class StoredLob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.StoredLob</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/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</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>="locator") +<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_LOB") +public abstract class <span class="strong">StoredLob</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a>></pre> +<div class="block">Can be used internally by repositories for supporting Lobs.</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/spi/LobEngine.html" title="class in com.amazon.carbonado.spi"><code>LobEngine</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 class </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></strong></code> +<div class="block">Blocks stored here.</div> +</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/spi/StoredLob.html#StoredLob()">StoredLob</a></strong>()</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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getBlockCount()">getBlockCount</a></strong>()</code> +<div class="block">Returns number of blocks required to store Lob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getBlockSize()">getBlockSize</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getLastBlockLength()">getLastBlockLength</a></strong>()</code> +<div class="block">Returns expected length of last block.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getLength()">getLength</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getLocator()">getLocator</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#setBlockSize(int)">setBlockSize</a></strong>(int size)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#setLength(long)">setLength</a></strong>(long length)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#setLocator(long)">setLocator</a></strong>(long locator)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredLob.html#setVersion(int)">setVersion</a></strong>(int version)</code> </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.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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StoredLob()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StoredLob</h4> +<pre>public StoredLob()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public abstract long getLocator()</pre> +</li> +</ul> +<a name="setLocator(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLocator</h4> +<pre>public abstract void setLocator(long locator)</pre> +</li> +</ul> +<a name="getBlockSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlockSize</h4> +<pre>public abstract int getBlockSize()</pre> +</li> +</ul> +<a name="setBlockSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlockSize</h4> +<pre><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">@IntegerConstraint</a>(<a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#min()">min</a>=1L) +public abstract void setBlockSize(int size)</pre> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public abstract long getLength()</pre> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre><a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint">@IntegerConstraint</a>(<a href="../../../../com/amazon/carbonado/constraint/IntegerConstraint.html#min()">min</a>=0L) +public abstract void setLength(long length)</pre> +</li> +</ul> +<a name="getVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersion</h4> +<pre><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado">@Version</a> +public abstract int getVersion()</pre> +</li> +</ul> +<a name="setVersion(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setVersion</h4> +<pre>public abstract void setVersion(int version)</pre> +</li> +</ul> +<a name="getBlockCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlockCount</h4> +<pre>public long getBlockCount()</pre> +<div class="block">Returns number of blocks required to store Lob.</div> +</li> +</ul> +<a name="getLastBlockLength()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLastBlockLength</h4> +<pre>public int getLastBlockLength()</pre> +<div class="block">Returns expected length of last block. If zero, last block should be + full, unless the total length of Lob is zero.</div> +</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/StoredLob.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/spi/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/StoredLob.html" target="_top">Frames</a></li> +<li><a href="StoredLob.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> diff --git a/apidocs/com/amazon/carbonado/spi/StoredSequence.html b/apidocs/com/amazon/carbonado/spi/StoredSequence.html new file mode 100644 index 0000000..3100bf1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/StoredSequence.html @@ -0,0 +1,320 @@ +<!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>StoredSequence (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="StoredSequence (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/StoredSequence.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/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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.spi</div> +<h2 title="Interface StoredSequence" class="title">Interface StoredSequence</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/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a>></dd> +</dl> +<hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</div> +<br> +<pre>@Deprecated +<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>="name") +<a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado">@Authoritative</a> +<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_SEQUENCE") +public interface <span class="strong">StoredSequence</span> +extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a>></pre> +<div class="block">Stores data for SequenceValueGenerator.</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/spi/StoredSequence.html#getInitialValue()">getInitialValue</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Returns the initial value for the sequence.</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/spi/StoredSequence.html#getName()">getName</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#getNextValue()">getNextValue</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Returns the pre-adjusted next value of the sequence.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#setInitialValue(long)">setInitialValue</a></strong>(long value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/StoredSequence.html#setNextValue(long)">setNextValue</a></strong>(long value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>void setName(java.lang.String name)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="getInitialValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialValue</h4> +<pre>long getInitialValue()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Returns the initial value for the sequence.</div> +</li> +</ul> +<a name="setInitialValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitialValue</h4> +<pre>void setInitialValue(long value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="getNextValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextValue</h4> +<pre>long getNextValue()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Returns the pre-adjusted next value of the sequence. This value is + initially Long.MIN_VALUE, and it increments up to Long.MAX_VALUE. The actual + next value for the sequence is: (getNextValue() + Long.MIN_VALUE + getInitialValue()).</div> +</li> +</ul> +<a name="setNextValue(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setNextValue</h4> +<pre>void setNextValue(long value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</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/StoredSequence.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/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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> diff --git a/apidocs/com/amazon/carbonado/spi/TriggerManager.html b/apidocs/com/amazon/carbonado/spi/TriggerManager.html new file mode 100644 index 0000000..747f969 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/TriggerManager.html @@ -0,0 +1,1324 @@ +<!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>TriggerManager (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="TriggerManager (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/TriggerManager.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/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/TriggerManager.html" target="_top">Frames</a></li> +<li><a href="TriggerManager.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_classes_inherited_from_class_com.amazon.carbonado.Trigger">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.spi</div> +<h2 title="Class TriggerManager" class="title">Class TriggerManager<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><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">com.amazon.carbonado.Trigger</a><S></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.TriggerManager<S></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">TriggerManager<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></pre> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers. This class is thread-safe and ensures that changes + to the trigger set do not affect transactions in progress.</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.Trigger"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></h3> +<code><a href="../../../../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></code></li> +</ul> +</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/spi/TriggerManager.html#TriggerManager()">TriggerManager</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#TriggerManager(java.lang.Class, java.lang.Iterable)">TriggerManager</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#addTrigger(com.amazon.carbonado.Trigger)">addTrigger</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#addTriggers(java.lang.Class, java.lang.Iterable)">addTriggers</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterDelete(S, java.lang.Object)">afterDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterInsert(S, java.lang.Object)">afterInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterLoad(S)">afterLoad</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called right after a storable has been successfully loaded or + fetched.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully deleted via + tryDelete.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully inserted via + tryInsert.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully updated via + tryUpdate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called right after a storable has been successfully updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable)</code> +<div class="block">Called before a storable is to be updated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#failedDelete(S, java.lang.Object)">failedDelete</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an delete operation failed because the record was missing or + an exception was thrown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#failedInsert(S, java.lang.Object)">failedInsert</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an insert operation failed due to a unique constraint + violation or an exception was thrown.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</code> +<div class="block">Called when an update operation failed because the record was missing or + an exception was thrown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getDeleteTrigger()">getDeleteTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for delete operations, or null if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getInsertTrigger()">getInsertTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for insert operations, or null if + none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getLoadTrigger()">getLoadTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for load operations, or null if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#getUpdateTrigger()">getUpdateTrigger</a></strong>()</code> +<div class="block">Returns a consolidated trigger to call for update operations, or null if + none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableDelete()">locallyDisableDelete</a></strong>()</code> +<div class="block">Disables execution of all managed delete triggers for the current + thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableInsert()">locallyDisableInsert</a></strong>()</code> +<div class="block">Disables execution of all managed insert triggers for the current + thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableLoad()">locallyDisableLoad</a></strong>()</code> +<div class="block">Disables execution of all managed load triggers for the current + thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableUpdate()">locallyDisableUpdate</a></strong>()</code> +<div class="block">Disables execution of all managed update triggers for the current + thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableDelete()">locallyEnableDelete</a></strong>()</code> +<div class="block">Enables execution of all managed delete triggers for the current thread, + if they had been disabled before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableInsert()">locallyEnableInsert</a></strong>()</code> +<div class="block">Enables execution of all managed insert triggers for the current thread, + if they had been disabled before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableLoad()">locallyEnableLoad</a></strong>()</code> +<div class="block">Enables execution of all managed load triggers for the current thread, + if they had been disabled before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableUpdate()">locallyEnableUpdate</a></strong>()</code> +<div class="block">Enables execution of all managed update triggers for the current thread, + if they had been disabled before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html#removeTrigger(com.amazon.carbonado.Trigger)">removeTrigger</a></strong>(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.Trigger"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></h3> +<code><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()">abortTry</a></code></li> +</ul> +<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> +</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="TriggerManager()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TriggerManager</h4> +<pre>public TriggerManager()</pre> +</li> +</ul> +<a name="TriggerManager(java.lang.Class, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TriggerManager</h4> +<pre>public TriggerManager(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>triggerFactories</code> - TriggerFactories which will be called upon to + optionally return a trigger to initially register</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></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="getInsertTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInsertTrigger</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> getInsertTrigger()</pre> +<div class="block">Returns a consolidated trigger to call for insert operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.</div> +</li> +</ul> +<a name="getUpdateTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUpdateTrigger</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> getUpdateTrigger()</pre> +<div class="block">Returns a consolidated trigger to call for update operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.</div> +</li> +</ul> +<a name="getDeleteTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeleteTrigger</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> getDeleteTrigger()</pre> +<div class="block">Returns a consolidated trigger to call for delete operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.</div> +</li> +</ul> +<a name="getLoadTrigger()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoadTrigger</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> getLoadTrigger()</pre> +<div class="block">Returns a consolidated trigger to call for load operations, or null if + none. If not null, the consolidated trigger is not a snapshot -- it will + change as the set of triggers in this manager changes.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="addTrigger(com.amazon.carbonado.Trigger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTrigger</h4> +<pre>public boolean addTrigger(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</pre> +</li> +</ul> +<a name="removeTrigger(com.amazon.carbonado.Trigger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeTrigger</h4> +<pre>public boolean removeTrigger(<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><? super <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> trigger)</pre> +</li> +</ul> +<a name="addTriggers(java.lang.Class, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTriggers</h4> +<pre>public void addTriggers(java.lang.Class<<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a>> type, + java.lang.Iterable<<a href="../../../../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a>> triggerFactories) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="locallyDisableInsert()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableInsert</h4> +<pre>public void locallyDisableInsert()</pre> +<div class="block">Disables execution of all managed insert triggers for the current + thread. Call locallyEnableInsert to enable again. This call can be made + multiple times, but be sure to call locallyEnableInsert the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableInsert()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyEnableInsert</h4> +<pre>public void locallyEnableInsert()</pre> +<div class="block">Enables execution of all managed insert triggers for the current thread, + if they had been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyDisableUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableUpdate</h4> +<pre>public void locallyDisableUpdate()</pre> +<div class="block">Disables execution of all managed update triggers for the current + thread. Call locallyEnableUpdate to enable again. This call can be made + multiple times, but be sure to call locallyEnableUpdate the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyEnableUpdate</h4> +<pre>public void locallyEnableUpdate()</pre> +<div class="block">Enables execution of all managed update triggers for the current thread, + if they had been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyDisableDelete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableDelete</h4> +<pre>public void locallyDisableDelete()</pre> +<div class="block">Disables execution of all managed delete triggers for the current + thread. Call locallyEnableDelete to enable again. This call can be made + multiple times, but be sure to call locallyEnableDelete the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableDelete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyEnableDelete</h4> +<pre>public void locallyEnableDelete()</pre> +<div class="block">Enables execution of all managed delete triggers for the current thread, + if they had been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyDisableLoad()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyDisableLoad</h4> +<pre>public void locallyDisableLoad()</pre> +<div class="block">Disables execution of all managed load triggers for the current + thread. Call locallyEnableLoad to enable again. This call can be made + multiple times, but be sure to call locallyEnableLoad the same number of + times to fully enable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="locallyEnableLoad()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>locallyEnableLoad</h4> +<pre>public void locallyEnableLoad()</pre> +<div class="block">Enables execution of all managed load triggers for the current thread, + if they had been disabled before.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="beforeInsert(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeInsert</h4> +<pre>public java.lang.Object beforeInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be inserted. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)">beforeInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterInsert or failedInsert method</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="beforeInsert(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeInsert(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeInsert</h4> +<pre>public java.lang.Object beforeInsert(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be inserted. The default implementation + simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)"><code>Trigger.beforeInsert(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterInsert or failedInsert method</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="beforeTryInsert(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryInsert(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryInsert</h4> +<pre>public java.lang.Object beforeTryInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be inserted via tryInsert. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeInsert(S)"><code>Trigger.beforeInsert(Object)</code></a>. Only override + if trigger needs to distinguish between different insert variants. + + <p>Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">beforeTryInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryInsert or failedInsert method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryInsert(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryInsert(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryInsert</h4> +<pre>public java.lang.Object beforeTryInsert(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be inserted via tryInsert. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)"><code>Trigger.beforeTryInsert(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different insert variants. + + <p>Any exception thrown by this method will cause the tryInsert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryInsert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being inserted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryInsert or failedInsert method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterInsert(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterInsert</h4> +<pre>public void afterInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully inserted. The + default implementation does nothing. + + <p>Any exception thrown by this method will cause the insert operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the insert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">afterInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable after being inserted</dd><dd><code>state</code> - object returned by beforeInsert method</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="afterTryInsert(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterTryInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryInsert</h4> +<pre>public void afterTryInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully inserted via + tryInsert. The default implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)"><code>Trigger.afterInsert(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different insert + variants. + + <p>Any exception thrown by this method will cause the tryInsert + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryInsert method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">afterTryInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable after being inserted</dd><dd><code>state</code> - object returned by beforeTryInsert method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedInsert(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="failedInsert(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedInsert</h4> +<pre>public void failedInsert(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#failedInsert(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called when an insert operation failed due to a unique constraint + violation or an exception was thrown. The main purpose of this method is + to allow any necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedInsert(S, java.lang.Object)">failedInsert</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable which failed to be inserted</dd><dd><code>state</code> - object returned by beforeInsert method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeUpdate(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be updated. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">beforeUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterUpdate or failedUpdate method</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="beforeUpdate(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeUpdate(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeUpdate</h4> +<pre>public java.lang.Object beforeUpdate(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be updated. The default implementation + simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)"><code>Trigger.beforeUpdate(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterUpdate or failedUpdate method</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="beforeTryUpdate(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryUpdate(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryUpdate</h4> +<pre>public java.lang.Object beforeTryUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be updated via tryUpdate. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeUpdate(S)"><code>Trigger.beforeUpdate(Object)</code></a>. Only override + if trigger needs to distinguish between different update variants. + + <p>Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">beforeTryUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryUpdate or failedUpdate method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryUpdate(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryUpdate(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryUpdate</h4> +<pre>public java.lang.Object beforeTryUpdate(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be updated via tryUpdate. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)"><code>Trigger.beforeTryUpdate(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different update variants. + + <p>Any exception thrown by this method will cause the tryUpdate operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryUpdate method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being updated</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryUpdate or failedUpdate method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterUpdate(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterUpdate</h4> +<pre>public void afterUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully updated. The default + implementation does nothing. + + <p>Any exception thrown by this method will cause the update operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the update method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">afterUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable after being updated</dd><dd><code>state</code> - optional object returned by beforeUpdate method</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="afterTryUpdate(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterTryUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryUpdate</h4> +<pre>public void afterTryUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully updated via + tryUpdate. The default implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)"><code>Trigger.afterUpdate(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different update + variants. + + <p>Any exception thrown by this method will cause the tryUpdate + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryUpdate method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable after being updated</dd><dd><code>state</code> - object returned by beforeTryUpdate method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedUpdate(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="failedUpdate(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedUpdate</h4> +<pre>public void failedUpdate(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#failedUpdate(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called when an update operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedUpdate(S, java.lang.Object)">failedUpdate</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable which failed to be updated</dd><dd><code>state</code> - optional object returned by beforeUpdate + method, but it may be null</dd></dl> +</li> +</ul> +<a name="beforeDelete(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeDelete(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeDelete</h4> +<pre>public java.lang.Object beforeDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be deleted. The default implementation + does nothing. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)">beforeDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterDelete or failedDelete method</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="beforeDelete(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeDelete(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeDelete</h4> +<pre>public java.lang.Object beforeDelete(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be deleted. The default implementation + simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)"><code>Trigger.beforeDelete(Object)</code></a>. Only override if access to + the transaction is required. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterDelete or failedDelete method</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="beforeTryDelete(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryDelete(S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryDelete</h4> +<pre>public java.lang.Object beforeTryDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be deleted via tryDelete. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeDelete(S)"><code>Trigger.beforeDelete(Object)</code></a>. Only override + if trigger needs to distinguish between different delete variants. + + <p>Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">beforeTryDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryDelete or failedDelete method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="beforeTryDelete(com.amazon.carbonado.Transaction,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="beforeTryDelete(com.amazon.carbonado.Transaction, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beforeTryDelete</h4> +<pre>public java.lang.Object beforeTryDelete(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> txn, + <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">Trigger</a></code></strong></div> +<div class="block">Called before a storable is to be deleted via tryDelete. The default + implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)"><code>Trigger.beforeTryDelete(Object)</code></a>. Only + override if trigger needs access to the transaction and to distinguish + between different delete variants. + + <p>Any exception thrown by this method will cause the tryDelete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the tryDelete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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>txn</code> - nested transaction which trigger runs in</dd><dd><code>storable</code> - storable before being deleted</dd> +<dt><span class="strong">Returns:</span></dt><dd>arbitrary state object, passed to afterTryDelete or failedDelete method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="afterDelete(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterDelete</h4> +<pre>public void afterDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully deleted. The default + implementation does nothing. + + <p>Any exception thrown by this method will cause the delete operation + to rollback and all remaining triggers to not run. The exception is + ultimately passed to the caller of the delete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">afterDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable after being deleted</dd><dd><code>state</code> - optional object returned by beforeDelete method</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="afterTryDelete(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="afterTryDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterTryDelete</h4> +<pre>public void afterTryDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully deleted via + tryDelete. The default implementation simply calls <a href="../../../../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)"><code>Trigger.afterDelete(S, java.lang.Object)</code></a>. + Only override if trigger needs to distinguish between different delete + variants. + + <p>Any exception thrown by this method will cause the tryDelete + operation to rollback and all remaining triggers to not run. The + exception is ultimately passed to the caller of the tryDelete method.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">afterTryDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable after being deleted</dd><dd><code>state</code> - object returned by beforeTryDelete method</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Trigger.html#abortTry()"><code>Trigger.abortTry()</code></a></dd></dl> +</li> +</ul> +<a name="failedDelete(com.amazon.carbonado.Storable,java.lang.Object)"> +<!-- --> +</a><a name="failedDelete(S, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failedDelete</h4> +<pre>public void failedDelete(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable, + java.lang.Object state)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#failedDelete(S, java.lang.Object)">Trigger</a></code></strong></div> +<div class="block">Called when an delete operation failed because the record was missing or + an exception was thrown. The main purpose of this method is to allow any + necessary clean-up to occur on the optional state object. + + <p>Any exception thrown by this method will be passed to the current + thread's uncaught exception handler.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#failedDelete(S, java.lang.Object)">failedDelete</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable which failed to be deleted</dd><dd><code>state</code> - optional object returned by beforeDelete + method, but it may be null</dd></dl> +</li> +</ul> +<a name="afterLoad(com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="afterLoad(S)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>afterLoad</h4> +<pre>public void afterLoad(<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> storable) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/Trigger.html#afterLoad(S)">Trigger</a></code></strong></div> +<div class="block">Called right after a storable has been successfully loaded or + fetched. The default implementation does nothing.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Trigger.html#afterLoad(S)">afterLoad</a></code> in class <code><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">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> - storable after being loaded or fetched</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> +</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/TriggerManager.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/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/TriggerManager.html" target="_top">Frames</a></li> +<li><a href="TriggerManager.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_classes_inherited_from_class_com.amazon.carbonado.Trigger">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> diff --git a/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html b/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html new file mode 100644 index 0000000..c47f68b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/TriggerManagerCapability.html @@ -0,0 +1,222 @@ +<!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>TriggerManagerCapability (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="TriggerManagerCapability (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/TriggerManagerCapability.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/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/TriggerManagerCapability.html" target="_top">Frames</a></li> +<li><a href="TriggerManagerCapability.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.spi</div> +<h2 title="Interface TriggerManagerCapability" class="title">Interface TriggerManagerCapability</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/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">TriggerManagerCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Provides the capability to get the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> from a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Pranay Dalmia</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><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html#getTriggerManagerFor(java.lang.Class)">getTriggerManagerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</table> +</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="getTriggerManagerFor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTriggerManagerFor</h4> +<pre><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S> getTriggerManagerFor(java.lang.Class<S> type) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Returns the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</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/TriggerManagerCapability.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/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/TriggerManagerCapability.html" target="_top">Frames</a></li> +<li><a href="TriggerManagerCapability.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html new file mode 100644 index 0000000..7326c96 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepository.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.AbstractRepository (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="Uses of Class com.amazon.carbonado.spi.AbstractRepository (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><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/AbstractRepository.html" target="_top">Frames</a></li> +<li><a href="AbstractRepository.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.AbstractRepository" class="title">Uses of Class<br>com.amazon.carbonado.spi.AbstractRepository</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.AbstractRepository</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/AbstractRepository.html" target="_top">Frames</a></li> +<li><a href="AbstractRepository.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html new file mode 100644 index 0000000..1fe8cc9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html @@ -0,0 +1,295 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.AbstractRepositoryBuilder (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="Uses of Class com.amazon.carbonado.spi.AbstractRepositoryBuilder (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><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="AbstractRepositoryBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.AbstractRepositoryBuilder" class="title">Uses of Class<br>com.amazon.carbonado.spi.AbstractRepositoryBuilder</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.map">com.amazon.carbonado.repo.map</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></strong></code> +<div class="block">Repository builder for the indexed repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></strong></code> +<div class="block">Builds a repository instance backed by a JDBC accessible database.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></strong></code> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.map"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></strong></code> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></strong></code> +<div class="block">Repository builder for the replicated repository.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a> in <a href="../../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></strong></code> +<div class="block">Builder and configuration options for BDBRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="AbstractRepositoryBuilder.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html b/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html new file mode 100644 index 0000000..9eaa0b0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.BelatedRepositoryCreator (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="Uses of Class com.amazon.carbonado.spi.BelatedRepositoryCreator (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><a href="../../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedRepositoryCreator.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.BelatedRepositoryCreator" class="title">Uses of Class<br>com.amazon.carbonado.spi.BelatedRepositoryCreator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.BelatedRepositoryCreator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/BelatedRepositoryCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedRepositoryCreator.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html b/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html new file mode 100644 index 0000000..4f07f2e --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.BelatedStorageCreator (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="Uses of Class com.amazon.carbonado.spi.BelatedStorageCreator (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><a href="../../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedStorageCreator.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.BelatedStorageCreator" class="title">Uses of Class<br>com.amazon.carbonado.spi.BelatedStorageCreator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.BelatedStorageCreator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/BelatedStorageCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedStorageCreator.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html b/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html new file mode 100644 index 0000000..05b0c88 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/ExceptionTransformer.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.ExceptionTransformer (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="Uses of Class com.amazon.carbonado.spi.ExceptionTransformer (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><a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/ExceptionTransformer.html" target="_top">Frames</a></li> +<li><a href="ExceptionTransformer.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.ExceptionTransformer" class="title">Uses of Class<br>com.amazon.carbonado.spi.ExceptionTransformer</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></code></td> +<td class="colLast"><span class="strong">ExceptionTransformer.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html#getInstance()">getInstance</a></strong>()</code> +<div class="block">Returns a generic instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/ExceptionTransformer.html" target="_top">Frames</a></li> +<li><a href="ExceptionTransformer.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html b/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html new file mode 100644 index 0000000..4a0d79d --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/IndexInfoImpl.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.IndexInfoImpl (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="Uses of Class com.amazon.carbonado.spi.IndexInfoImpl (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><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/IndexInfoImpl.html" target="_top">Frames</a></li> +<li><a href="IndexInfoImpl.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.IndexInfoImpl" class="title">Uses of Class<br>com.amazon.carbonado.spi.IndexInfoImpl</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.IndexInfoImpl</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/IndexInfoImpl.html" target="_top">Frames</a></li> +<li><a href="IndexInfoImpl.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html b/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html new file mode 100644 index 0000000..6f6ee1d --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/LobEngine.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.LobEngine (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="Uses of Class com.amazon.carbonado.spi.LobEngine (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><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.LobEngine" class="title">Uses of Class<br>com.amazon.carbonado.spi.LobEngine</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.LobEngine</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html b/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html new file mode 100644 index 0000000..a03e900 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RAFInputStream.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.RAFInputStream (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="Uses of Class com.amazon.carbonado.spi.RAFInputStream (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><a href="../../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RAFInputStream.html" target="_top">Frames</a></li> +<li><a href="RAFInputStream.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.RAFInputStream" class="title">Uses of Class<br>com.amazon.carbonado.spi.RAFInputStream</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.RAFInputStream</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RAFInputStream.html" target="_top">Frames</a></li> +<li><a href="RAFInputStream.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html b/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html new file mode 100644 index 0000000..d966568 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RAFOutputStream.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.RAFOutputStream (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="Uses of Class com.amazon.carbonado.spi.RAFOutputStream (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><a href="../../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RAFOutputStream.html" target="_top">Frames</a></li> +<li><a href="RAFOutputStream.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.RAFOutputStream" class="title">Uses of Class<br>com.amazon.carbonado.spi.RAFOutputStream</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.RAFOutputStream</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RAFOutputStream.html" target="_top">Frames</a></li> +<li><a href="RAFOutputStream.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html b/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html new file mode 100644 index 0000000..3c1030b --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/RepairExecutor.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.RepairExecutor (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="Uses of Class com.amazon.carbonado.spi.RepairExecutor (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><a href="../../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RepairExecutor.html" target="_top">Frames</a></li> +<li><a href="RepairExecutor.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.RepairExecutor" class="title">Uses of Class<br>com.amazon.carbonado.spi.RepairExecutor</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.RepairExecutor</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/RepairExecutor.html" target="_top">Frames</a></li> +<li><a href="RepairExecutor.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html b/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html new file mode 100644 index 0000000..d1978d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoragePool.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.StoragePool (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="Uses of Class com.amazon.carbonado.spi.StoragePool (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><a href="../../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoragePool.html" target="_top">Frames</a></li> +<li><a href="StoragePool.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.StoragePool" class="title">Uses of Class<br>com.amazon.carbonado.spi.StoragePool</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.StoragePool</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoragePool.html" target="_top">Frames</a></li> +<li><a href="StoragePool.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html new file mode 100644 index 0000000..5546179 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.Block.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.StoredLob.Block (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="Uses of Class com.amazon.carbonado.spi.StoredLob.Block (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><a href="../../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredLob.Block.html" target="_top">Frames</a></li> +<li><a href="StoredLob.Block.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.StoredLob.Block" class="title">Uses of Class<br>com.amazon.carbonado.spi.StoredLob.Block</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.StoredLob.Block</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredLob.Block.html" target="_top">Frames</a></li> +<li><a href="StoredLob.Block.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html new file mode 100644 index 0000000..d1c031c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredLob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.StoredLob (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="Uses of Class com.amazon.carbonado.spi.StoredLob (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><a href="../../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredLob.html" target="_top">Frames</a></li> +<li><a href="StoredLob.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.StoredLob" class="title">Uses of Class<br>com.amazon.carbonado.spi.StoredLob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.StoredLob</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredLob.html" target="_top">Frames</a></li> +<li><a href="StoredLob.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html b/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html new file mode 100644 index 0000000..360ae87 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/StoredSequence.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.spi.StoredSequence (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="Uses of Interface com.amazon.carbonado.spi.StoredSequence (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><a href="../../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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"> +<h2 title="Uses of Interface com.amazon.carbonado.spi.StoredSequence" class="title">Uses of Interface<br>com.amazon.carbonado.spi.StoredSequence</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.StoredSequence</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/StoredSequence.html" target="_top">Frames</a></li> +<li><a href="StoredSequence.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html new file mode 100644 index 0000000..d94488c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManager.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.spi.TriggerManager (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="Uses of Class com.amazon.carbonado.spi.TriggerManager (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><a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/TriggerManager.html" target="_top">Frames</a></li> +<li><a href="TriggerManager.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"> +<h2 title="Uses of Class com.amazon.carbonado.spi.TriggerManager" class="title">Uses of Class<br>com.amazon.carbonado.spi.TriggerManager</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a><S></code></td> +<td class="colLast"><span class="strong">TriggerManagerCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html#getTriggerManagerFor(java.lang.Class)">getTriggerManagerFor</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Returns the <a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/TriggerManager.html" target="_top">Frames</a></li> +<li><a href="TriggerManager.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> diff --git a/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html new file mode 100644 index 0000000..7292f09 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.spi.TriggerManagerCapability (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="Uses of Interface com.amazon.carbonado.spi.TriggerManagerCapability (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><a href="../../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html" target="_top">Frames</a></li> +<li><a href="TriggerManagerCapability.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"> +<h2 title="Uses of Interface com.amazon.carbonado.spi.TriggerManagerCapability" class="title">Uses of Interface<br>com.amazon.carbonado.spi.TriggerManagerCapability</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.spi.TriggerManagerCapability</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/spi/class-use/TriggerManagerCapability.html" target="_top">Frames</a></li> +<li><a href="TriggerManagerCapability.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> diff --git a/apidocs/com/amazon/carbonado/spi/package-frame.html b/apidocs/com/amazon/carbonado/spi/package-frame.html new file mode 100644 index 0000000..53b98ae --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-frame.html @@ -0,0 +1,38 @@ +<!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.spi (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/spi/package-summary.html" target="classFrame">com.amazon.carbonado.spi</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="StoredSequence.html" title="interface in com.amazon.carbonado.spi" target="classFrame"><i>StoredSequence</i></a></li> +<li><a href="TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi" target="classFrame"><i>TriggerManagerCapability</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractRepository.html" title="class in com.amazon.carbonado.spi" target="classFrame">AbstractRepository</a></li> +<li><a href="AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi" target="classFrame">AbstractRepositoryBuilder</a></li> +<li><a href="BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi" target="classFrame">BelatedRepositoryCreator</a></li> +<li><a href="BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi" target="classFrame">BelatedStorageCreator</a></li> +<li><a href="ExceptionTransformer.html" title="class in com.amazon.carbonado.spi" target="classFrame">ExceptionTransformer</a></li> +<li><a href="IndexInfoImpl.html" title="class in com.amazon.carbonado.spi" target="classFrame">IndexInfoImpl</a></li> +<li><a href="LobEngine.html" title="class in com.amazon.carbonado.spi" target="classFrame">LobEngine</a></li> +<li><a href="RAFInputStream.html" title="class in com.amazon.carbonado.spi" target="classFrame">RAFInputStream</a></li> +<li><a href="RAFOutputStream.html" title="class in com.amazon.carbonado.spi" target="classFrame">RAFOutputStream</a></li> +<li><a href="RepairExecutor.html" title="class in com.amazon.carbonado.spi" target="classFrame">RepairExecutor</a></li> +<li><a href="StoragePool.html" title="class in com.amazon.carbonado.spi" target="classFrame">StoragePool</a></li> +<li><a href="StoredLob.html" title="class in com.amazon.carbonado.spi" target="classFrame">StoredLob</a></li> +<li><a href="StoredLob.Block.html" title="class in com.amazon.carbonado.spi" target="classFrame">StoredLob.Block</a></li> +<li><a href="TriggerManager.html" title="class in com.amazon.carbonado.spi" target="classFrame">TriggerManager</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/spi/package-summary.html b/apidocs/com/amazon/carbonado/spi/package-summary.html new file mode 100644 index 0000000..f7a106c --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-summary.html @@ -0,0 +1,254 @@ +<!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.spi (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.spi (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><a href="../../../../com/amazon/carbonado/sequence/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/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.spi</h1> +<div class="docSummary"> +<div class="block">Service Provider Interface 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/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></td> +<td class="colLast">Deprecated +<div class="block"><i>Replaced by <a href="../../../../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">TriggerManagerCapability</a></td> +<td class="colLast"> +<div class="block">Provides the capability to get the <a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> from a <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</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/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a><Txn></td> +<td class="colLast"> +<div class="block">Implements basic functionality required by a core Repository.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></td> +<td class="colLast"> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></td> +<td class="colLast"> +<div class="block">Generic one-shot Repository builder which supports late object creation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</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">Generic one-shot Storage creator which supports late object creation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></td> +<td class="colLast"> +<div class="block">Supports transforming arbitrary exceptions into appropriate repository + exceptions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></td> +<td class="colLast"> +<div class="block">Basic implementation of an <a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></td> +<td class="colLast"> +<div class="block">Complete Lob support for repositories, although repository is responsible + for binding Lob properties to this engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">RAFInputStream</a></td> +<td class="colLast"> +<div class="block">InputStream that wraps a RandomAccessFile.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">RAFOutputStream</a></td> +<td class="colLast"> +<div class="block">OutputStream that wraps a RandomAccessFile.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi">RepairExecutor</a></td> +<td class="colLast"> +<div class="block">A convenience class for repositories to run dynamic repairs in separate + threads.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></td> +<td class="colLast"> +<div class="block">A concurrent pool of strongly referenced Storage instances mapped by + Storable type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></td> +<td class="colLast"> +<div class="block">Can be used internally by repositories for supporting Lobs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></td> +<td class="colLast"> +<div class="block">Blocks stored here.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</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">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.spi Description">Package com.amazon.carbonado.spi Description</h2> +<div class="block">Service Provider Interface for Carbonado. Repositories are free to use this + package to aid in their implementation. User-level applications have no need + to use this package.</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><a href="../../../../com/amazon/carbonado/sequence/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/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> diff --git a/apidocs/com/amazon/carbonado/spi/package-tree.html b/apidocs/com/amazon/carbonado/spi/package-tree.html new file mode 100644 index 0000000..b74945f --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-tree.html @@ -0,0 +1,176 @@ +<!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.spi Class Hierarchy (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.spi Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/sequence/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.spi</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util"><span class="strong">AbstractPool</span></a><K,V,E> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoragePool</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepository</span></a><Txn> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>, com.amazon.carbonado.sequence.<a href="../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a>, com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a>)</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a>)</li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util"><span class="strong">BelatedCreator</span></a><T,E> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">BelatedRepositoryCreator</span></a></li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">BelatedStorageCreator</span></a><S></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">ExceptionTransformer</span></a></li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">IndexInfoImpl</span></a> (implements com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>)</li> +<li type="circle">java.io.InputStream (implements java.io.Closeable) +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">RAFInputStream</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">LobEngine</span></a></li> +<li type="circle">java.io.OutputStream (implements java.io.Closeable, java.io.Flushable) +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">RAFOutputStream</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">RepairExecutor</span></a></li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoredLob</span></a> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoredLob.Block</span></a> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><S>)</li> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Trigger</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">TriggerManager</span></a><S></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.capability.<a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi"><span class="strong">TriggerManagerCapability</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><S> +<ul> +<li type="circle">com.amazon.carbonado.spi.<a href="../../../../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">StoredSequence</span></a></li> +</ul> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/sequence/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/spi/package-use.html b/apidocs/com/amazon/carbonado/spi/package-use.html new file mode 100644 index 0000000..bcc5806 --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/package-use.html @@ -0,0 +1,303 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.spi (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="Uses of Package com.amazon.carbonado.spi (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.spi" class="title">Uses of Package<br>com.amazon.carbonado.spi</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.logging">com.amazon.carbonado.repo.logging</a></td> +<td class="colLast"> +<div class="block">Repository implementation which logs activity against it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.map">com.amazon.carbonado.repo.map</a></td> +<td class="colLast"> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.replicated">com.amazon.carbonado.repo.replicated</a></td> +<td class="colLast"> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.sleepycat">com.amazon.carbonado.repo.sleepycat</a></td> +<td class="colLast"> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.indexed">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.jdbc">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.logging"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.logging">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.map"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.map">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.replicated"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.replicated">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.sleepycat"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/AbstractRepositoryBuilder.html#com.amazon.carbonado.repo.sleepycat">AbstractRepositoryBuilder</a> +<div class="block">Abstract builder class for opening repositories.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/ExceptionTransformer.html#com.amazon.carbonado.spi">ExceptionTransformer</a> +<div class="block">Supports transforming arbitrary exceptions into appropriate repository + exceptions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/spi/class-use/TriggerManager.html#com.amazon.carbonado.spi">TriggerManager</a> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/ClassFileBuilder.html b/apidocs/com/amazon/carbonado/synthetic/ClassFileBuilder.html new file mode 100644 index 0000000..4ca888b --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/ClassFileBuilder.html @@ -0,0 +1,347 @@ +<!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>ClassFileBuilder (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="ClassFileBuilder (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/ClassFileBuilder.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/ClassFileBuilder.html" target="_top">Frames</a></li> +<li><a href="ClassFileBuilder.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.synthetic</div> +<h2 title="Class ClassFileBuilder" class="title">Class ClassFileBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.synthetic.ClassFileBuilder</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">ClassFileBuilder</span> +extends java.lang.Object</pre> +<div class="block">Simple interface representing a partially filled class and injector pair. + + <P>This is abstract because it provides no mechanism for defining the + classfile or injector; subclasses must provide them.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected org.cojen.classfile.ClassFile</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html#mClassFile">mClassFile</a></strong></code> +<div class="block">Partially hydrogenated class operators</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected org.cojen.util.ClassInjector</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html#mInjector">mInjector</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/synthetic/ClassFileBuilder.html#ClassFileBuilder()">ClassFileBuilder</a></strong>()</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>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html#build()">build</a></strong>()</code> +<div class="block">Defines the class for this generator</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.ClassFile</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html#getClassFile()">getClassFile</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.cojen.util.ClassInjector</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html#getInjector()">getInjector</a></strong>()</code> </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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="mClassFile"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mClassFile</h4> +<pre>protected org.cojen.classfile.ClassFile mClassFile</pre> +<div class="block">Partially hydrogenated class operators</div> +</li> +</ul> +<a name="mInjector"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>mInjector</h4> +<pre>protected org.cojen.util.ClassInjector mInjector</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ClassFileBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ClassFileBuilder</h4> +<pre>public ClassFileBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getClassFile()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClassFile</h4> +<pre>public org.cojen.classfile.ClassFile getClassFile()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the classFile.</dd></dl> +</li> +</ul> +<a name="getInjector()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInjector</h4> +<pre>public org.cojen.util.ClassInjector getInjector()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the injector.</dd></dl> +</li> +</ul> +<a name="build()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public java.lang.Class build()</pre> +<div class="block">Defines the class for this generator</div> +</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/ClassFileBuilder.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/ClassFileBuilder.html" target="_top">Frames</a></li> +<li><a href="ClassFileBuilder.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html new file mode 100644 index 0000000..4e9a6cf --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html @@ -0,0 +1,233 @@ +<!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>SyntheticBuilder.ClassNameProvider (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="SyntheticBuilder.ClassNameProvider (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/SyntheticBuilder.ClassNameProvider.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/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" target="_top">Frames</a></li> +<li><a href="SyntheticBuilder.ClassNameProvider.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.synthetic</div> +<h2 title="Interface SyntheticBuilder.ClassNameProvider" class="title">Interface SyntheticBuilder.ClassNameProvider</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">SyntheticBuilder.ClassNameProvider</span></pre> +<div class="block">Interface used to get the name for the class to generate. This allows the + client to apply different rules for classname generation.</div> +</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html#isExplicit()">isExplicit</a></strong>()</code> +<div class="block">SyntheticBuilder may choose to alter the class name to prevent a + class name collision.</div> +</td> +</tr> +</table> +</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="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +</li> +</ul> +<a name="isExplicit()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isExplicit</h4> +<pre>boolean isExplicit()</pre> +<div class="block">SyntheticBuilder may choose to alter the class name to prevent a + class name collision. When explicit is true, the class name must not + be altered.</div> +</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/SyntheticBuilder.ClassNameProvider.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/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" target="_top">Frames</a></li> +<li><a href="SyntheticBuilder.ClassNameProvider.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html new file mode 100644 index 0000000..139651a --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticBuilder.html @@ -0,0 +1,413 @@ +<!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>SyntheticBuilder (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="SyntheticBuilder (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/SyntheticBuilder.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/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticBuilder.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>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.synthetic</div> +<h2 title="Interface SyntheticBuilder" class="title">Interface SyntheticBuilder</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">SyntheticBuilder</span></pre> +<div class="block">A synthetic builder provides a mechanism for creating a user storable from scratch. + The client creates the builder, decorates with properties and indexes on those + properties, then builds. + + If additional, ad hoc decoration is desired, the partially constructed classfile + can be retrieved and operated on directly via the ClassFileBuilder + returned by <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>prepare()</code></a>.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider, David Rosenstrauch</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">Interface 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/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></strong></code> +<div class="block">Interface used to get the name for the class to generate.</div> +</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/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">addAlternateKey</a></strong>()</code> +<div class="block">Add an alternate key to be built.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">addIndex</a></strong>()</code> +<div class="block">Add an index to the set managed by this builder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">addPrimaryKey</a></strong>()</code> +<div class="block">Add a primary key to be built.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></strong>(java.lang.String name, + java.lang.Class type)</code> +<div class="block">Add a property to the set managed by this builder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> +<div class="block">Add an externally defined synthetic property to the list</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">build</a></strong>()</code> +<div class="block">Convenience method to generate the class.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()">getStorableClass</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">hasProperty</a></strong>(java.lang.String name)</code> +<div class="block">Check to see if a particular property has already been added to the list of + properties to generate</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">isVersioned</a></strong>()</code> +<div class="block">Returns true if a property with the version attribute has been addded</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()">prepare</a></strong>()</code> </td> +</tr> +</table> +</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="prepare()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a> prepare() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl><dt><span class="strong">Returns:</span></dt><dd><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>ClassFileBuilder</code></a> ready for further decoration or building</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></dd></dl> +</li> +</ul> +<a name="getStorableClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableClass</h4> +<pre>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getStorableClass() + throws java.lang.IllegalStateException</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the generated class file for this builder. Note that + proper operation requires that <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>prepare()</code></a> already have been called + prior to calling this method.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if build has not yet been called.</dd></dl> +</li> +</ul> +<a name="build()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> build() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block">Convenience method to generate the class. + Build will always call <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>prepare()</code></a> and return the result of + generating the class from that classfile. If the caller does not + wish to regenerate the class from scratch, use <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()"><code>getStorableClass()</code></a> instead.</div> +<dl><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></dd></dl> +</li> +</ul> +<a name="addProperty(java.lang.String, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addProperty(java.lang.String name, + java.lang.Class type)</pre> +<div class="block">Add a property to the set managed by this builder.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the property</dd><dd><code>type</code> - of the property</dd> +<dt><span class="strong">Returns:</span></dt><dd>property specification which can be further refined</dd></dl> +</li> +</ul> +<a name="addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addProperty(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</pre> +<div class="block">Add an externally defined synthetic property to the list</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prop</code> - to add</dd> +<dt><span class="strong">Returns:</span></dt><dd>original synthetic property as a convenience</dd></dl> +</li> +</ul> +<a name="hasProperty(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasProperty</h4> +<pre>boolean hasProperty(java.lang.String name)</pre> +<div class="block">Check to see if a particular property has already been added to the list of + properties to generate</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd></dl> +</li> +</ul> +<a name="addPrimaryKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPrimaryKey</h4> +<pre><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> addPrimaryKey()</pre> +<div class="block">Add a primary key to be built.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the primary key</dd></dl> +</li> +</ul> +<a name="addAlternateKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAlternateKey</h4> +<pre><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> addAlternateKey()</pre> +<div class="block">Add an alternate key to be built.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the alternate key</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="addIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addIndex</h4> +<pre><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a> addIndex()</pre> +<div class="block">Add an index to the set managed by this builder. All indexes added this + way will be in addition to the primary and alternate key indexes.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>index to be decorated with property values defining the index</dd></dl> +</li> +</ul> +<a name="isVersioned()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isVersioned</h4> +<pre>boolean isVersioned()</pre> +<div class="block">Returns true if a property with the version attribute has been addded</div> +</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/SyntheticBuilder.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/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticBuilder.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>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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticIndex.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticIndex.html new file mode 100644 index 0000000..cc93898 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticIndex.html @@ -0,0 +1,206 @@ +<!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>SyntheticIndex (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="SyntheticIndex (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/SyntheticIndex.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/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticIndex.html" target="_top">Frames</a></li> +<li><a href="SyntheticIndex.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="#methods_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticPropertyList">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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.synthetic</div> +<h2 title="Class SyntheticIndex" class="title">Class SyntheticIndex</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic.SyntheticPropertyList</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.synthetic.SyntheticIndex</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">SyntheticIndex</span> +extends <a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></pre> +<div class="block">Specification of a collection of properties which will participate in an index. Each + property has its own direction specification.</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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticPropertyList"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></h3> +<code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String)">addProperty</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addProperty</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getProperties()">getProperties</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getPropertyCount()">getPropertyCount</a></code></li> +</ul> +<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> +</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/SyntheticIndex.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/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticIndex.html" target="_top">Frames</a></li> +<li><a href="SyntheticIndex.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="#methods_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticPropertyList">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticKey.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticKey.html new file mode 100644 index 0000000..27720d9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticKey.html @@ -0,0 +1,206 @@ +<!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>SyntheticKey (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="SyntheticKey (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/SyntheticKey.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/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticKey.html" target="_top">Frames</a></li> +<li><a href="SyntheticKey.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="#methods_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticPropertyList">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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.synthetic</div> +<h2 title="Class SyntheticKey" class="title">Class SyntheticKey</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic.SyntheticPropertyList</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.synthetic.SyntheticKey</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">SyntheticKey</span> +extends <a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></pre> +<div class="block">Specification of a collection of properties which will participate in a key. Each + property has its own direction specification.</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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticPropertyList"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></h3> +<code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String)">addProperty</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addProperty</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getProperties()">getProperties</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getPropertyCount()">getPropertyCount</a></code></li> +</ul> +<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> +</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/SyntheticKey.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/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticKey.html" target="_top">Frames</a></li> +<li><a href="SyntheticKey.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="#methods_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticPropertyList">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticProperty.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticProperty.html new file mode 100644 index 0000000..a50f3cf --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticProperty.html @@ -0,0 +1,570 @@ +<!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>SyntheticProperty (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="SyntheticProperty (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/SyntheticProperty.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/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticProperty.html" target="_top">Frames</a></li> +<li><a href="SyntheticProperty.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><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.synthetic</div> +<h2 title="Class SyntheticProperty" class="title">Class SyntheticProperty</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.synthetic.SyntheticProperty</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Comparable<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SyntheticProperty</span> +extends java.lang.Object +implements java.lang.Comparable<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>></pre> +<div class="block">Minimal specification of a storable property for use with a <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>SyntheticStorableBuilder</code></a>. + Synthetic storables can be used to generate user storables.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/synthetic/SyntheticProperty.html#SyntheticProperty(java.lang.String, java.lang.Class)">SyntheticProperty</a></strong>(java.lang.String name, + java.lang.Class type)</code> +<div class="block">Every property requires minimally a name and a type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#SyntheticProperty(java.lang.String, java.lang.Class, boolean, boolean)">SyntheticProperty</a></strong>(java.lang.String name, + java.lang.Class type, + boolean isNullable, + boolean isVersion)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#addAccessorAnnotationDescriptor(java.lang.String)">addAccessorAnnotationDescriptor</a></strong>(java.lang.String annotationDesc)</code> +<div class="block">Add an arbitrary annotation to the property accessor method, as + specified by a descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#compareTo(com.amazon.carbonado.synthetic.SyntheticProperty)">compareTo</a></strong>(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> otherProp)</code> +<div class="block"><code>Comparable</code> implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getAccessorAnnotationDescriptors()">getAccessorAnnotationDescriptors</a></strong>()</code> +<div class="block">Returns all the added accessor annotation descriptors in an unmodifiable list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getAdapter()">getAdapter</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getReadMethodName()">getReadMethodName</a></strong>()</code> +<div class="block">Returns the name of the read method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getType()">getType</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getWriteMethodName()">getWriteMethodName</a></strong>()</code> +<div class="block">Returns the name of the write method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#isNullable()">isNullable</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#isVersion()">isVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#makeReadMethodName(java.lang.String, java.lang.Class)">makeReadMethodName</a></strong>(java.lang.String name, + java.lang.Class type)</code> +<div class="block">Generate a name for a bean "get" method ("is" method, for booleans).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#makeWriteMethodName(java.lang.String)">makeWriteMethodName</a></strong>(java.lang.String name)</code> +<div class="block">Generate a name for a bean "set" method</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#setAdapter(com.amazon.carbonado.info.StorablePropertyAdapter)">setAdapter</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> adapter)</code> +<div class="block">Storables cannot currently have more than one adapter per property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#setIsNullable(boolean)">setIsNullable</a></strong>(boolean isNullable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#setIsVersion(boolean)">setIsVersion</a></strong>(boolean isVersion)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#toString()">toString</a></strong>()</code> </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, finalize, getClass, notify, notifyAll, wait, wait, wait</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="SyntheticProperty(java.lang.String, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SyntheticProperty</h4> +<pre>public SyntheticProperty(java.lang.String name, + java.lang.Class type)</pre> +<div class="block">Every property requires minimally a name and a type</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - for the property</dd><dd><code>type</code> - of the data it contains</dd></dl> +</li> +</ul> +<a name="SyntheticProperty(java.lang.String, java.lang.Class, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SyntheticProperty</h4> +<pre>public SyntheticProperty(java.lang.String name, + java.lang.Class type, + boolean isNullable, + boolean isVersion)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - property name</dd><dd><code>type</code> - property type</dd><dd><code>isNullable</code> - true if this property can be null (default false)</dd><dd><code>isVersion</code> - true if this property is a version number (default false)</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="makeReadMethodName(java.lang.String, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>makeReadMethodName</h4> +<pre>public static java.lang.String makeReadMethodName(java.lang.String name, + java.lang.Class type)</pre> +<div class="block">Generate a name for a bean "get" method ("is" method, for booleans).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the property</dd><dd><code>type</code> - return type of the property</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getReadMethodName()"><code>getReadMethodName()</code></a></dd></dl> +</li> +</ul> +<a name="makeWriteMethodName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>makeWriteMethodName</h4> +<pre>public static java.lang.String makeWriteMethodName(java.lang.String name)</pre> +<div class="block">Generate a name for a bean "set" method</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the property</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getWriteMethodName()"><code>getWriteMethodName()</code></a></dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Name of the property</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public java.lang.Class getType()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>type of the property</dd></dl> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>public boolean isNullable()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the property can be null</dd></dl> +</li> +</ul> +<a name="setIsNullable(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIsNullable</h4> +<pre>public void setIsNullable(boolean isNullable)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isNullable</code> - true if the property can be null</dd></dl> +</li> +</ul> +<a name="isVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersion</h4> +<pre>public boolean isVersion()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the property contains the versioning information for the storable. Note that + at most one property can be the version property for a given storable</dd></dl> +</li> +</ul> +<a name="setIsVersion(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIsVersion</h4> +<pre>public void setIsVersion(boolean isVersion)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isVersion</code> - true if the property should contain the versioning information for the + storable</dd></dl> +</li> +</ul> +<a name="getReadMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadMethodName</h4> +<pre>public java.lang.String getReadMethodName()</pre> +<div class="block">Returns the name of the read method.</div> +</li> +</ul> +<a name="getWriteMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteMethodName</h4> +<pre>public java.lang.String getWriteMethodName()</pre> +<div class="block">Returns the name of the write method.</div> +</li> +</ul> +<a name="getAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> getAdapter()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>the optional adapter.</dd></dl> +</li> +</ul> +<a name="setAdapter(com.amazon.carbonado.info.StorablePropertyAdapter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAdapter</h4> +<pre>public void setAdapter(<a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> adapter)</pre> +<div class="block">Storables cannot currently have more than one adapter per property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>adapter</code> - The adapter to set.</dd></dl> +</li> +</ul> +<a name="addAccessorAnnotationDescriptor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAccessorAnnotationDescriptor</h4> +<pre>public void addAccessorAnnotationDescriptor(java.lang.String annotationDesc)</pre> +<div class="block">Add an arbitrary annotation to the property accessor method, as + specified by a descriptor.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util"><code>AnnotationDescPrinter</code></a></dd></dl> +</li> +</ul> +<a name="getAccessorAnnotationDescriptors()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAccessorAnnotationDescriptors</h4> +<pre>public java.util.List<java.lang.String> getAccessorAnnotationDescriptors()</pre> +<div class="block">Returns all the added accessor annotation descriptors in an unmodifiable list.</div> +</li> +</ul> +<a name="compareTo(com.amazon.carbonado.synthetic.SyntheticProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int compareTo(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> otherProp)</pre> +<div class="block"><code>Comparable</code> implementation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>otherProp</code> - </dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object o)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/SyntheticProperty.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/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticProperty.html" target="_top">Frames</a></li> +<li><a href="SyntheticProperty.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><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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticPropertyList.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticPropertyList.html new file mode 100644 index 0000000..ddf1aa0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticPropertyList.html @@ -0,0 +1,289 @@ +<!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>SyntheticPropertyList (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="SyntheticPropertyList (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/SyntheticPropertyList.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/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticPropertyList.html" target="_top">Frames</a></li> +<li><a href="SyntheticPropertyList.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.synthetic</div> +<h2 title="Class SyntheticPropertyList" class="title">Class SyntheticPropertyList</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.synthetic.SyntheticPropertyList</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a>, <a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">SyntheticPropertyList</span> +extends java.lang.Object</pre> +<div class="block">Specification of a collection of properties which will participate in a key + or index. Each property has its own direction specification.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Don Schneider</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/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String)">addProperty</a></strong>(java.lang.String propertyName)</code> +<div class="block">Adds a property to this index, with an unspecified direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Adds a property to this index, with the specified direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Iterator<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns all the properties in this index, optionally prefixed with a '+' + or '-' to indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getPropertyCount()">getPropertyCount</a></strong>()</code> +<div class="block">Returns the count of properties in this index.</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> +</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="addProperty(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public void addProperty(java.lang.String propertyName)</pre> +<div class="block">Adds a property to this index, with an unspecified direction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to add to index</dd></dl> +</li> +</ul> +<a name="addProperty(java.lang.String, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public void addProperty(java.lang.String propertyName, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Adds a property to this index, with the specified direction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property to add to index</dd><dd><code>direction</code> - optional direction of property</dd></dl> +</li> +</ul> +<a name="getPropertyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyCount</h4> +<pre>public int getPropertyCount()</pre> +<div class="block">Returns the count of properties in this index.</div> +</li> +</ul> +<a name="getProperties()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>public java.util.Iterator<java.lang.String> getProperties()</pre> +<div class="block">Returns all the properties in this index, optionally prefixed with a '+' + or '-' to indicate direction.</div> +</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/SyntheticPropertyList.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/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticPropertyList.html" target="_top">Frames</a></li> +<li><a href="SyntheticPropertyList.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html new file mode 100644 index 0000000..4e65bfc --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html @@ -0,0 +1,621 @@ +<!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>SyntheticStorableBuilder (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="SyntheticStorableBuilder (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/SyntheticStorableBuilder.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/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableBuilder.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><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.synthetic</div> +<h2 title="Class SyntheticStorableBuilder" class="title">Class SyntheticStorableBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.synthetic.SyntheticStorableBuilder</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/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SyntheticStorableBuilder</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></pre> +<div class="block">Allows the definition of very simple synthetic storables. Only a primary key + index can be defined; at least one property must be a primary key property. A + property can be nullable and can be specified as the version property. + + This class acts both as builder factory and as builder.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider, Brian S O'Neill, David Rosenstrauch</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticBuilder"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></h3> +<code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></code></li> +</ul> +</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/synthetic/SyntheticStorableBuilder.html#SyntheticStorableBuilder(java.lang.String, java.lang.ClassLoader)">SyntheticStorableBuilder</a></strong>(java.lang.String name, + java.lang.ClassLoader loader)</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/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addAlternateKey()">addAlternateKey</a></strong>()</code> +<div class="block">Add an alternate key to be built.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addIndex()">addIndex</a></strong>()</code> +<div class="block">Add an index to the set managed by this builder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addPrimaryKey()">addPrimaryKey</a></strong>()</code> +<div class="block">Add a primary key to be built.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></strong>(java.lang.String name, + java.lang.Class type)</code> +<div class="block">Add a property to the set managed by this builder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> +<div class="block">Add an externally defined synthetic property to the list</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#build()">build</a></strong>()</code> +<div class="block">Convenience method to generate the class.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#definePropertyBeanMethods(org.cojen.classfile.ClassFile, com.amazon.carbonado.synthetic.SyntheticProperty)">definePropertyBeanMethods</a></strong>(org.cojen.classfile.ClassFile cf, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> property)</code> +<div class="block">Add the get & set methods for this property</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getClassNameProvider()">getClassNameProvider</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Frequently used by the <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.util.List<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getPropertyList()">getPropertyList</a></strong>()</code> +<div class="block">Frequently used by the <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getStorableClass()">getStorableClass</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#hasProperty(java.lang.String)">hasProperty</a></strong>(java.lang.String name)</code> +<div class="block">Check to see if a particular property has already been added to the list of + properties to generate</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#isVersioned()">isVersioned</a></strong>()</code> +<div class="block">Returns true if a property with the version attribute has been addded</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#prepare()">prepare</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#setClassNameProvider(com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider)">setClassNameProvider</a></strong>(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> classNameProvider)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#setEvolvable(boolean)">setEvolvable</a></strong>(boolean evolvable)</code> +<div class="block">By default, generated storable implements the Unevolvable marker + interface, which can affect how it is encoded.</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/synthetic/SyntheticStorableBuilder.html#toString()">toString</a></strong>()</code> </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, wait, wait, wait</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="SyntheticStorableBuilder(java.lang.String, java.lang.ClassLoader)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SyntheticStorableBuilder</h4> +<pre>public SyntheticStorableBuilder(java.lang.String name, + java.lang.ClassLoader loader)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - base name for the generated class. This is usually a fully qualified + name, a la "com.amazon.carbonado.storables.happy.synthetic.storable"</dd><dd><code>loader</code> - <code>ClassLoader</code> to use for the generated class</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="prepare()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a> prepare() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()">prepare</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>ClassFileBuilder</code></a> ready for further decoration or building</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></dd></dl> +</li> +</ul> +<a name="getStorableClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getStorableClass()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()">getStorableClass</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the generated class file for this builder. Note that + proper operation requires that <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>SyntheticBuilder.prepare()</code></a> already have been called + prior to calling this method.</dd></dl> +</li> +</ul> +<a name="build()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> build() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">SyntheticBuilder</a></code></strong></div> +<div class="block">Convenience method to generate the class. + Build will always call <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>SyntheticBuilder.prepare()</code></a> and return the result of + generating the class from that classfile. If the caller does not + wish to regenerate the class from scratch, use <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()"><code>SyntheticBuilder.getStorableClass()</code></a> instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">build</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></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></dd></dl> +</li> +</ul> +<a name="addProperty(java.lang.String, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addProperty(java.lang.String name, + java.lang.Class type)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">SyntheticBuilder</a></code></strong></div> +<div class="block">Add a property to the set managed by this builder.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the property</dd><dd><code>type</code> - of the property</dd> +<dt><span class="strong">Returns:</span></dt><dd>property specification which can be further refined</dd></dl> +</li> +</ul> +<a name="addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addProperty(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">SyntheticBuilder</a></code></strong></div> +<div class="block">Add an externally defined synthetic property to the list</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>prop</code> - to add</dd> +<dt><span class="strong">Returns:</span></dt><dd>original synthetic property as a convenience</dd></dl> +</li> +</ul> +<a name="hasProperty(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasProperty</h4> +<pre>public boolean hasProperty(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">SyntheticBuilder</a></code></strong></div> +<div class="block">Check to see if a particular property has already been added to the list of + properties to generate</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">hasProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +</dl> +</li> +</ul> +<a name="addPrimaryKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPrimaryKey</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> addPrimaryKey()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">SyntheticBuilder</a></code></strong></div> +<div class="block">Add a primary key to be built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">addPrimaryKey</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the primary key</dd></dl> +</li> +</ul> +<a name="addAlternateKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAlternateKey</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> addAlternateKey()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">SyntheticBuilder</a></code></strong></div> +<div class="block">Add an alternate key to be built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">addAlternateKey</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the alternate key</dd></dl> +</li> +</ul> +<a name="addIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addIndex</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a> addIndex()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">SyntheticBuilder</a></code></strong></div> +<div class="block">Add an index to the set managed by this builder. All indexes added this + way will be in addition to the primary and alternate key indexes.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">addIndex</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>index to be decorated with property values defining the index</dd></dl> +</li> +</ul> +<a name="isVersioned()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersioned</h4> +<pre>public boolean isVersioned()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">SyntheticBuilder</a></code></strong></div> +<div class="block">Returns true if a property with the version attribute has been addded</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">isVersioned</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +</dl> +</li> +</ul> +<a name="getClassNameProvider()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClassNameProvider</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> getClassNameProvider()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the classNameProvider.</dd></dl> +</li> +</ul> +<a name="setClassNameProvider(com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClassNameProvider</h4> +<pre>public void setClassNameProvider(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> classNameProvider)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classNameProvider</code> - The classNameProvider to set.</dd></dl> +</li> +</ul> +<a name="setEvolvable(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEvolvable</h4> +<pre>public void setEvolvable(boolean evolvable)</pre> +<div class="block">By default, generated storable implements the Unevolvable marker + interface, which can affect how it is encoded. It usually does not make + sense to support storable evolution new versions can be (and often will + be) given different names. + + <p>Pass in true to change from the default behavior, and not implement + Unevolvable. When doing so, a ClassNameProvider should also be provided + to ensure consistent naming which does not include property names.</div> +</li> +</ul> +<a name="definePropertyBeanMethods(org.cojen.classfile.ClassFile, com.amazon.carbonado.synthetic.SyntheticProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>definePropertyBeanMethods</h4> +<pre>protected boolean definePropertyBeanMethods(org.cojen.classfile.ClassFile cf, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> property)</pre> +<div class="block">Add the get & set methods for this property</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if version property was added</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>protected java.lang.String getName()</pre> +<div class="block">Frequently used by the <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>builder name</dd></dl> +</li> +</ul> +<a name="getPropertyList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyList</h4> +<pre>protected java.util.List<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>> getPropertyList()</pre> +<div class="block">Frequently used by the <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>properties for this storable</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/SyntheticStorableBuilder.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/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableBuilder.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><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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html new file mode 100644 index 0000000..9b834f5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html @@ -0,0 +1,346 @@ +<!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>SyntheticStorableReferenceAccess (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="SyntheticStorableReferenceAccess (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/SyntheticStorableReferenceAccess.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/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceAccess.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.synthetic</div> +<h2 title="Class SyntheticStorableReferenceAccess" class="title">Class SyntheticStorableReferenceAccess<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.synthetic.SyntheticStorableReferenceAccess<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">SyntheticStorableReferenceAccess<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object</pre> +<div class="block">Provides access to the generated storable reference class and utility + methods.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd> +<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/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>SyntheticStorableReferenceBuilder</code></a></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/synthetic/SyntheticStorableReferenceAccess.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Sets all the properties of the given reference, using the applicable + properties of the given master.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given reference.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Comparator<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getComparator()">getComparator</a></strong>()</code> +<div class="block">Returns a comparator for ordering storable reference instances.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getMasterClass()">getMasterClass</a></strong>()</code> +<div class="block">Returns the storable class which is referenced.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getReferenceClass()">getReferenceClass</a></strong>()</code> +<div class="block">Returns the generated storable reference class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master)</code> +<div class="block">Returns true if the properties of the given reference match those + contained in the master, excluding any version property.</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> +</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="getMasterClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMasterClass</h4> +<pre>public java.lang.Class<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a>> getMasterClass()</pre> +<div class="block">Returns the storable class which is referenced.</div> +</li> +</ul> +<a name="getReferenceClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReferenceClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getReferenceClass()</pre> +<div class="block">Returns the generated storable reference class.</div> +</li> +</ul> +<a name="getComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getComparator</h4> +<pre>public java.util.Comparator<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getComparator()</pre> +<div class="block">Returns a comparator for ordering storable reference instances. This + order matches the primary key of the master storable.</div> +</li> +</ul> +<a name="copyToMasterPrimaryKey(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyToMasterPrimaryKey</h4> +<pre>public void copyToMasterPrimaryKey(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given reference.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - source of property values</dd><dd><code>master</code> - master whose primary key properties will be set</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="copyFromMaster(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyFromMaster(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyFromMaster</h4> +<pre>public void copyFromMaster(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Sets all the properties of the given reference, using the applicable + properties of the given master.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - reference whose properties will be set</dd><dd><code>master</code> - source of property values</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="isConsistent(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="isConsistent(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isConsistent</h4> +<pre>public boolean isConsistent(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> reference, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> master) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns true if the properties of the given reference match those + contained in the master, excluding any version property. This will + always return true after a call to copyFromMaster.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - reference whose properties will be tested</dd><dd><code>master</code> - source of property values</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> +</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/SyntheticStorableReferenceAccess.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/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceAccess.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html new file mode 100644 index 0000000..75ec3d5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html @@ -0,0 +1,727 @@ +<!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>SyntheticStorableReferenceBuilder (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="SyntheticStorableReferenceBuilder (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/SyntheticStorableReferenceBuilder.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/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceBuilder.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><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.synthetic</div> +<h2 title="Class SyntheticStorableReferenceBuilder" class="title">Class SyntheticStorableReferenceBuilder<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.synthetic.SyntheticStorableReferenceBuilder<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/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SyntheticStorableReferenceBuilder<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/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></pre> +<div class="block">A SyntheticStorableReference defines new kinds of Storables from an existing + master storable. This is used in situations when additional information about + a storable needs to be tracked -- eg, for an index, or for caching. The + storable may optionally have completely new, synthetic properties added. + + <P> + All primary key properties of the master storable will also be provided by the + derived storable. Three special methods will be provided: + <ul> + <li>getMaster - retrieves the original storable</li> + <li>setAllProperties - sets the properties the syntheticReference has in + common with the master to the values of the master instance</li> + <li>isConsistent - verifies that the properties the syntheticReference has + in common with the master are consistent with an instance of the master, + meaning that they are in the same state and, if set, equal.</li> + </ul></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Don Schneider, David Rosenstrauch</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_com.amazon.carbonado.synthetic.SyntheticBuilder"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></h3> +<code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></code></li> +</ul> +</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/synthetic/SyntheticStorableReferenceBuilder.html#SyntheticStorableReferenceBuilder(java.lang.Class, boolean)">SyntheticStorableReferenceBuilder</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a>> storableClass, + boolean isUnique)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#SyntheticStorableReferenceBuilder(java.lang.Class, java.lang.String, boolean)">SyntheticStorableReferenceBuilder</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a>> storableClass, + java.lang.String baseName, + boolean isUnique)</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/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addAlternateKey()">addAlternateKey</a></strong>()</code> +<div class="block">Add an alternate key to be built.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addIndex()">addIndex</a></strong>()</code> +<div class="block">Add an index to the set managed by this builder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addKeyProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addKeyProperty</a></strong>(java.lang.String name, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Add a property to the primary key which is a member of the Storable type + being referenced by this one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addPrimaryKey()">addPrimaryKey</a></strong>()</code> +<div class="block">Add a primary key to be built.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></strong>(java.lang.String name, + java.lang.Class type)</code> +<div class="block">Add a property to the set managed by this builder.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> +<div class="block">Add an externally defined synthetic property to the list</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#build()">build</a></strong>()</code> +<div class="block">Convenience method to generate the class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Comparator<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getComparator()">getComparator</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a><<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getReferenceAccess()">getReferenceAccess</a></strong>()</code> +<div class="block">Build and return access to the generated storable reference class.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getStorableClass()">getStorableClass</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getUserProps()">getUserProps</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#hasProperty(java.lang.String)">hasProperty</a></strong>(java.lang.String name)</code> +<div class="block">Check to see if a particular property has already been added to the list of + properties to generate</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent</a></strong>(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isUnique()">isUnique</a></strong>()</code> +<div class="block">True if the generated derived class should be considered unique.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isVersioned()">isVersioned</a></strong>()</code> +<div class="block">Returns true if a property with the version attribute has been addded</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#prepare()">prepare</a></strong>()</code> </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> +</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="SyntheticStorableReferenceBuilder(java.lang.Class, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SyntheticStorableReferenceBuilder</h4> +<pre>public SyntheticStorableReferenceBuilder(java.lang.Class<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a>> storableClass, + boolean isUnique)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storableClass</code> - class of the storable that will be referenced by this + synthetic. The name for the synthetic storable will be based + on this class's name, decorated with the properties which + participate in the primary key for the synthetic storable.</dd></dl> +</li> +</ul> +<a name="SyntheticStorableReferenceBuilder(java.lang.Class, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SyntheticStorableReferenceBuilder</h4> +<pre>public SyntheticStorableReferenceBuilder(java.lang.Class<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a>> storableClass, + java.lang.String baseName, + boolean isUnique)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>storableClass</code> - class of the storable that will be referenced by this + synthetic</dd><dd><code>baseName</code> - of the generated synthetic. Note that for some repositories + this name will be visible across the entire repository, so it + is good practice to include namespace information to guarantee + uniqueness.</dd><dd><code>isUnique</code> - true if the properties that are explicitly identified as primary + key properites are sufficient to uniquely identify the index object.</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="prepare()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a> prepare() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()">prepare</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>ClassFileBuilder</code></a> ready for further decoration or building</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></dd></dl> +</li> +</ul> +<a name="getReferenceAccess()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReferenceAccess</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a><<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a>> getReferenceAccess()</pre> +<div class="block">Build and return access to the generated storable reference class.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd></dl> +</li> +</ul> +<a name="getStorableClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getStorableClass() + throws java.lang.IllegalStateException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()">getStorableClass</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the generated class file for this builder. Note that + proper operation requires that <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>SyntheticBuilder.prepare()</code></a> already have been called + prior to calling this method.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if build has not yet been called.</dd></dl> +</li> +</ul> +<a name="build()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> build() + throws <a href="../../../../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">SyntheticBuilder</a></code></strong></div> +<div class="block">Convenience method to generate the class. + Build will always call <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()"><code>SyntheticBuilder.prepare()</code></a> and return the result of + generating the class from that classfile. If the caller does not + wish to regenerate the class from scratch, use <a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()"><code>SyntheticBuilder.getStorableClass()</code></a> instead.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">build</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></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></dd></dl> +</li> +</ul> +<a name="addKeyProperty(java.lang.String, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addKeyProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addKeyProperty(java.lang.String name, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Add a property to the primary key which is a member of the Storable type + being referenced by this one.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd></dl> +</li> +</ul> +<a name="addProperty(java.lang.String, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addProperty(java.lang.String name, + java.lang.Class type)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">SyntheticBuilder</a></code></strong></div> +<div class="block">Add a property to the set managed by this builder.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the property</dd><dd><code>type</code> - of the property</dd> +<dt><span class="strong">Returns:</span></dt><dd>property specification which can be further refined</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(java.lang.String, java.lang.Class)"><code>SyntheticStorableBuilder.addProperty(java.lang.String, + java.lang.Class)</code></a></dd></dl> +</li> +</ul> +<a name="addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> addProperty(<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">SyntheticBuilder</a></code></strong></div> +<div class="block">Add an externally defined synthetic property to the list</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>prop</code> - to add</dd> +<dt><span class="strong">Returns:</span></dt><dd>original synthetic property as a convenience</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)"><code>SyntheticStorableBuilder.addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)</code></a></dd></dl> +</li> +</ul> +<a name="hasProperty(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasProperty</h4> +<pre>public boolean hasProperty(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">SyntheticBuilder</a></code></strong></div> +<div class="block">Check to see if a particular property has already been added to the list of + properties to generate</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">hasProperty</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +</dl> +</li> +</ul> +<a name="getUserProps()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserProps</h4> +<pre>public java.util.List<<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>> getUserProps()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the indexProps.</dd></dl> +</li> +</ul> +<a name="addPrimaryKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addPrimaryKey</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> addPrimaryKey()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">SyntheticBuilder</a></code></strong></div> +<div class="block">Add a primary key to be built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">addPrimaryKey</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the primary key</dd></dl> +</li> +</ul> +<a name="addAlternateKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAlternateKey</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> addAlternateKey()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">SyntheticBuilder</a></code></strong></div> +<div class="block">Add an alternate key to be built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">addAlternateKey</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>key to be decorated with property values defining the alternate key</dd></dl> +</li> +</ul> +<a name="addIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addIndex</h4> +<pre>public <a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a> addIndex()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">SyntheticBuilder</a></code></strong></div> +<div class="block">Add an index to the set managed by this builder. All indexes added this + way will be in addition to the primary and alternate key indexes.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">addIndex</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>index to be decorated with property values defining the index</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.Object getName()</pre> +</li> +</ul> +<a name="isUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUnique</h4> +<pre>public boolean isUnique()</pre> +<div class="block">True if the generated derived class should be considered unique. If + non-unique, all properties are added to the primary key so there will be + no conflicts between various derived classes derived from the same base + storable.</div> +</li> +</ul> +<a name="isVersioned()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersioned</h4> +<pre>public boolean isVersioned()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">SyntheticBuilder</a></code></strong></div> +<div class="block">Returns true if a property with the version attribute has been addded</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">isVersioned</a></code> in interface <code><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></code></dd> +</dl> +</li> +</ul> +<a name="copyToMasterPrimaryKey(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyToMasterPrimaryKey</h4> +<pre>@Deprecated +public void copyToMasterPrimaryKey(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> <i>call getReferenceAccess</i></div> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - source of property values</dd><dd><code>master</code> - master whose primary key properties will be set</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="copyFromMaster(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="copyFromMaster(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyFromMaster</h4> +<pre>@Deprecated +public void copyFromMaster(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> <i>call getReferenceAccess</i></div> +<div class="block">Sets all the properties of the given index entry, using the applicable + properties of the given master.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - index entry whose properties will be set</dd><dd><code>master</code> - source of property values</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="isConsistent(com.amazon.carbonado.Storable,com.amazon.carbonado.Storable)"> +<!-- --> +</a><a name="isConsistent(com.amazon.carbonado.Storable, S)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isConsistent</h4> +<pre>@Deprecated +public boolean isConsistent(<a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a> indexEntry, + <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> master) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><span class="strong">Deprecated.</span> <i>call getReferenceAccess</i></div> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, excluding any version property. This will + always return true after a call to copyFromMaster.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indexEntry</code> - index entry whose properties will be tested</dd><dd><code>master</code> - source of property values</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="getComparator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getComparator</h4> +<pre>@Deprecated +public java.util.Comparator<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getComparator()</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>call getReferenceAccess</i></div> +<div class="block">Returns a comparator for ordering index entries.</div> +</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/SyntheticStorableReferenceBuilder.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/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceBuilder.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><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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html new file mode 100644 index 0000000..8336989 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html @@ -0,0 +1,168 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.synthetic.ClassFileBuilder (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="Uses of Class com.amazon.carbonado.synthetic.ClassFileBuilder (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><a href="../../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html" target="_top">Frames</a></li> +<li><a href="ClassFileBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.synthetic.ClassFileBuilder" class="title">Uses of Class<br>com.amazon.carbonado.synthetic.ClassFileBuilder</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return <a href="../../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#prepare()">prepare</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#prepare()">prepare</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()">prepare</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html" target="_top">Frames</a></li> +<li><a href="ClassFileBuilder.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html new file mode 100644 index 0000000..ed6d885 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html @@ -0,0 +1,173 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider (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="Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html" target="_top">Frames</a></li> +<li><a href="SyntheticBuilder.ClassNameProvider.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"> +<h2 title="Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider" class="title">Uses of Interface<br>com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getClassNameProvider()">getClassNameProvider</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> with parameters of type <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#setClassNameProvider(com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider)">setClassNameProvider</a></strong>(<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> classNameProvider)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html" target="_top">Frames</a></li> +<li><a href="SyntheticBuilder.ClassNameProvider.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html new file mode 100644 index 0000000..718e671 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html @@ -0,0 +1,169 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder (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="Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticBuilder.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"> +<h2 title="Uses of Interface com.amazon.carbonado.synthetic.SyntheticBuilder" class="title">Uses of Interface<br>com.amazon.carbonado.synthetic.SyntheticBuilder</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that implement <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></strong></code> +<div class="block">Allows the definition of very simple synthetic storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">A SyntheticStorableReference defines new kinds of Storables from an existing + master storable.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticBuilder.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html new file mode 100644 index 0000000..d7d38a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html @@ -0,0 +1,170 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.synthetic.SyntheticIndex (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="Uses of Class com.amazon.carbonado.synthetic.SyntheticIndex (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html" target="_top">Frames</a></li> +<li><a href="SyntheticIndex.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"> +<h2 title="Uses of Class com.amazon.carbonado.synthetic.SyntheticIndex" class="title">Uses of Class<br>com.amazon.carbonado.synthetic.SyntheticIndex</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addIndex()">addIndex</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addIndex()">addIndex</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">addIndex</a></strong>()</code> +<div class="block">Add an index to the set managed by this builder.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html" target="_top">Frames</a></li> +<li><a href="SyntheticIndex.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html new file mode 100644 index 0000000..c8a9bbd --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticKey.html @@ -0,0 +1,184 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.synthetic.SyntheticKey (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="Uses of Class com.amazon.carbonado.synthetic.SyntheticKey (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticKey.html" target="_top">Frames</a></li> +<li><a href="SyntheticKey.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"> +<h2 title="Uses of Class com.amazon.carbonado.synthetic.SyntheticKey" class="title">Uses of Class<br>com.amazon.carbonado.synthetic.SyntheticKey</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addAlternateKey()">addAlternateKey</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addAlternateKey()">addAlternateKey</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">addAlternateKey</a></strong>()</code> +<div class="block">Add an alternate key to be built.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addPrimaryKey()">addPrimaryKey</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addPrimaryKey()">addPrimaryKey</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">addPrimaryKey</a></strong>()</code> +<div class="block">Add a primary key to be built.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticKey.html" target="_top">Frames</a></li> +<li><a href="SyntheticKey.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html new file mode 100644 index 0000000..502d77f --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html @@ -0,0 +1,251 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.synthetic.SyntheticProperty (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="Uses of Class com.amazon.carbonado.synthetic.SyntheticProperty (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html" target="_top">Frames</a></li> +<li><a href="SyntheticProperty.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"> +<h2 title="Uses of Class com.amazon.carbonado.synthetic.SyntheticProperty" class="title">Uses of Class<br>com.amazon.carbonado.synthetic.SyntheticProperty</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addKeyProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addKeyProperty</a></strong>(java.lang.String name, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Add a property to the primary key which is a member of the Storable type + being referenced by this one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></strong>(java.lang.String name, + java.lang.Class type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></strong>(java.lang.String name, + java.lang.Class type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty</a></strong>(java.lang.String name, + java.lang.Class type)</code> +<div class="block">Add a property to the set managed by this builder.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> +<div class="block">Add an externally defined synthetic property to the list</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected java.util.List<<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getPropertyList()">getPropertyList</a></strong>()</code> +<div class="block">Frequently used by the <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getUserProps()">getUserProps</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> with parameters of type <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> prop)</code> +<div class="block">Add an externally defined synthetic property to the list</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="strong">SyntheticProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#compareTo(com.amazon.carbonado.synthetic.SyntheticProperty)">compareTo</a></strong>(<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> otherProp)</code> +<div class="block"><code>Comparable</code> implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><span class="strong">SyntheticStorableBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#definePropertyBeanMethods(org.cojen.classfile.ClassFile, com.amazon.carbonado.synthetic.SyntheticProperty)">definePropertyBeanMethods</a></strong>(org.cojen.classfile.ClassFile cf, + <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a> property)</code> +<div class="block">Add the get & set methods for this property</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html" target="_top">Frames</a></li> +<li><a href="SyntheticProperty.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html new file mode 100644 index 0000000..bb6edb3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html @@ -0,0 +1,168 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.synthetic.SyntheticPropertyList (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="Uses of Class com.amazon.carbonado.synthetic.SyntheticPropertyList (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html" target="_top">Frames</a></li> +<li><a href="SyntheticPropertyList.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"> +<h2 title="Uses of Class com.amazon.carbonado.synthetic.SyntheticPropertyList" class="title">Uses of Class<br>com.amazon.carbonado.synthetic.SyntheticPropertyList</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></strong></code> +<div class="block">Specification of a collection of properties which will participate in an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></strong></code> +<div class="block">Specification of a collection of properties which will participate in a key.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html" target="_top">Frames</a></li> +<li><a href="SyntheticPropertyList.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html new file mode 100644 index 0000000..0709686 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableBuilder (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="Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableBuilder (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableBuilder" class="title">Uses of Class<br>com.amazon.carbonado.synthetic.SyntheticStorableBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.synthetic.SyntheticStorableBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticStorableBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableBuilder.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html new file mode 100644 index 0000000..1a5915e --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess (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="Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceAccess.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"> +<h2 title="Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess" class="title">Uses of Class<br>com.amazon.carbonado.synthetic.SyntheticStorableReferenceAccess</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return <a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a><<a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a>></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getReferenceAccess()">getReferenceAccess</a></strong>()</code> +<div class="block">Build and return access to the generated storable reference class.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceAccess.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html new file mode 100644 index 0000000..91c893c --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder (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="Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder (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><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder" class="title">Uses of Class<br>com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceBuilder.html" target="_top">Frames</a></li> +<li><a href="SyntheticStorableReferenceBuilder.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/package-frame.html b/apidocs/com/amazon/carbonado/synthetic/package-frame.html new file mode 100644 index 0000000..1b07fca --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/package-frame.html @@ -0,0 +1,32 @@ +<!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.synthetic (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/synthetic/package-summary.html" target="classFrame">com.amazon.carbonado.synthetic</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic" target="classFrame"><i>SyntheticBuilder</i></a></li> +<li><a href="SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic" target="classFrame"><i>SyntheticBuilder.ClassNameProvider</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic" target="classFrame">ClassFileBuilder</a></li> +<li><a href="SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic" target="classFrame">SyntheticIndex</a></li> +<li><a href="SyntheticKey.html" title="class in com.amazon.carbonado.synthetic" target="classFrame">SyntheticKey</a></li> +<li><a href="SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic" target="classFrame">SyntheticProperty</a></li> +<li><a href="SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic" target="classFrame">SyntheticPropertyList</a></li> +<li><a href="SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic" target="classFrame">SyntheticStorableBuilder</a></li> +<li><a href="SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic" target="classFrame">SyntheticStorableReferenceAccess</a></li> +<li><a href="SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic" target="classFrame">SyntheticStorableReferenceBuilder</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/synthetic/package-summary.html b/apidocs/com/amazon/carbonado/synthetic/package-summary.html new file mode 100644 index 0000000..df0ae0f --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/package-summary.html @@ -0,0 +1,216 @@ +<!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.synthetic (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.synthetic (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><a href="../../../../com/amazon/carbonado/spi/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/txn/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/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.synthetic</h1> +<div class="docSummary"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</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/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></td> +<td class="colLast"> +<div class="block">A synthetic builder provides a mechanism for creating a user storable from scratch.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></td> +<td class="colLast"> +<div class="block">Interface used to get the name for the class to generate.</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/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></td> +<td class="colLast"> +<div class="block">Simple interface representing a partially filled class and injector pair.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic">SyntheticIndex</a></td> +<td class="colLast"> +<div class="block">Specification of a collection of properties which will participate in an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic">SyntheticKey</a></td> +<td class="colLast"> +<div class="block">Specification of a collection of properties which will participate in a key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></td> +<td class="colLast"> +<div class="block">Minimal specification of a storable property for use with a <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>SyntheticStorableBuilder</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></td> +<td class="colLast"> +<div class="block">Specification of a collection of properties which will participate in a key + or index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></td> +<td class="colLast"> +<div class="block">Allows the definition of very simple synthetic storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</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">Provides access to the generated storable reference class and utility + methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</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">A SyntheticStorableReference defines new kinds of Storables from an existing + master storable.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.synthetic Description">Package com.amazon.carbonado.synthetic Description</h2> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</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><a href="../../../../com/amazon/carbonado/spi/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/txn/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/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> diff --git a/apidocs/com/amazon/carbonado/synthetic/package-tree.html b/apidocs/com/amazon/carbonado/synthetic/package-tree.html new file mode 100644 index 0000000..c03631f --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/package-tree.html @@ -0,0 +1,145 @@ +<!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.synthetic Class Hierarchy (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.synthetic Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/spi/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/txn/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.synthetic</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">ClassFileBuilder</span></a></li> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticProperty</span></a> (implements java.lang.Comparable<T>)</li> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticPropertyList</span></a> +<ul> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticIndex</span></a></li> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticKey</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticStorableBuilder</span></a> (implements com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a>)</li> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticStorableReferenceAccess</span></a><S></li> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticStorableReferenceBuilder</span></a><S> (implements com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">SyntheticBuilder</span></a></li> +<li type="circle">com.amazon.carbonado.synthetic.<a href="../../../../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">SyntheticBuilder.ClassNameProvider</span></a></li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/spi/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/txn/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/synthetic/package-use.html b/apidocs/com/amazon/carbonado/synthetic/package-use.html new file mode 100644 index 0000000..088e697 --- /dev/null +++ b/apidocs/com/amazon/carbonado/synthetic/package-use.html @@ -0,0 +1,192 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.synthetic (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="Uses of Package com.amazon.carbonado.synthetic (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.synthetic" class="title">Uses of Package<br>com.amazon.carbonado.synthetic</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> used by <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/synthetic/class-use/ClassFileBuilder.html#com.amazon.carbonado.synthetic">ClassFileBuilder</a> +<div class="block">Simple interface representing a partially filled class and injector pair.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.html#com.amazon.carbonado.synthetic">SyntheticBuilder</a> +<div class="block">A synthetic builder provides a mechanism for creating a user storable from scratch.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/synthetic/class-use/SyntheticBuilder.ClassNameProvider.html#com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a> +<div class="block">Interface used to get the name for the class to generate.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/synthetic/class-use/SyntheticIndex.html#com.amazon.carbonado.synthetic">SyntheticIndex</a> +<div class="block">Specification of a collection of properties which will participate in an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/synthetic/class-use/SyntheticKey.html#com.amazon.carbonado.synthetic">SyntheticKey</a> +<div class="block">Specification of a collection of properties which will participate in a key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/synthetic/class-use/SyntheticProperty.html#com.amazon.carbonado.synthetic">SyntheticProperty</a> +<div class="block">Minimal specification of a storable property for use with a <a href="../../../../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>SyntheticStorableBuilder</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/synthetic/class-use/SyntheticPropertyList.html#com.amazon.carbonado.synthetic">SyntheticPropertyList</a> +<div class="block">Specification of a collection of properties which will participate in a key + or index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/synthetic/class-use/SyntheticStorableReferenceAccess.html#com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a> +<div class="block">Provides access to the generated storable reference class and utility + methods.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/synthetic/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/txn/TransactionManager.html b/apidocs/com/amazon/carbonado/txn/TransactionManager.html new file mode 100644 index 0000000..eae85dc --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionManager.html @@ -0,0 +1,573 @@ +<!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>TransactionManager (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="TransactionManager (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/TransactionManager.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionManager.html" target="_top">Frames</a></li> +<li><a href="TransactionManager.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><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.txn</div> +<h2 title="Class TransactionManager" class="title">Class TransactionManager<Txn></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.txn.TransactionManager<Txn></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>Txn</code> - Transaction implementation</dd></dl> +<hr> +<br> +<pre>public abstract class <span class="strong">TransactionManager<Txn></span> +extends java.lang.Object</pre> +<div class="block">Generic transaction manager for repositories.</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"> +<!-- ======== 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/txn/TransactionManager.html#TransactionManager()">TransactionManager</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#TransactionManager(com.amazon.carbonado.txn.TransactionMonitor)">TransactionManager</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a> monitor)</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>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#abortTxn(Txn)">abortTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Aborts and closes the given internal transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#attachNotification(Txn)">attachNotification</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Called to notify internal method that transaction is attached.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#close(boolean)">close</a></strong>(boolean suspend)</code> +<div class="block">Closes all transaction scopes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#commitTxn(Txn)">commitTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Commits and closes the given internal transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#createTxn(Txn, com.amazon.carbonado.IsolationLevel)">createTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#createTxn(Txn, com.amazon.carbonado.IsolationLevel, int, java.util.concurrent.TimeUnit)">createTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level, + int timeout, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#detachLocalScope()">detachLocalScope</a></strong>()</code> +<div class="block">Detaches the thread-local TransactionScope from the current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#detachNotification(Txn)">detachNotification</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Called to notify internal method that transaction is detached.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#isClosed()">isClosed</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#localScope()">localScope</a></strong>()</code> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#reuseTxn(Txn)">reuseTxn</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</code> +<div class="block">Called when a transaction is about to be reused.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#selectIsolationLevel(com.amazon.carbonado.Transaction, com.amazon.carbonado.IsolationLevel)">selectIsolationLevel</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Returns supported isolation level, which may be higher.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#setForUpdate(Txn, boolean)">setForUpdate</a></strong>(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn, + boolean forUpdate)</code> +<div class="block">Called when the Transaction.setForUpdate method is called.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#supportsForUpdate()">supportsForUpdate</a></strong>()</code> +<div class="block">Return true if transactions support "for update" mode.</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> +</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="TransactionManager()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TransactionManager</h4> +<pre>public TransactionManager()</pre> +</li> +</ul> +<a name="TransactionManager(com.amazon.carbonado.txn.TransactionMonitor)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionManager</h4> +<pre>public TransactionManager(<a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a> monitor)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="localScope()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>localScope</h4> +<pre>public <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>> localScope()</pre> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</li> +</ul> +<a name="detachLocalScope()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>detachLocalScope</h4> +<pre>public <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>> detachLocalScope()</pre> +<div class="block">Detaches the thread-local TransactionScope from the current thread. It + can be <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#attach()"><code>attached</code></a> later, and to any thread + which does not currently have a TransactionScope.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>detached thread-local TransactionScope or null if none</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="close(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close(boolean suspend) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Closes all transaction scopes. Should be called only when repository is + closed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>suspend</code> - when true, indefinitely suspend all threads interacting + with transactions</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="isClosed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public boolean isClosed()</pre> +</li> +</ul> +<a name="selectIsolationLevel(com.amazon.carbonado.Transaction, com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>selectIsolationLevel</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> selectIsolationLevel(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Returns supported isolation level, which may be higher. If isolation + level cannot go higher (or lower than parent) then return null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - optional parent transaction</dd><dd><code>level</code> - desired isolation level (may be null)</dd></dl> +</li> +</ul> +<a name="supportsForUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>supportsForUpdate</h4> +<pre>protected abstract boolean supportsForUpdate()</pre> +<div class="block">Return true if transactions support "for update" mode.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="createTxn(java.lang.Object,com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a><a name="createTxn(Txn, com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createTxn</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> createTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level) + throws java.lang.Exception</pre> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction. If parent is not null and real nested transactions are not + supported, simply return parent transaction for supporting fake nested + transactions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - optional parent transaction</dd><dd><code>level</code> - required isolation level</dd> +<dt><span class="strong">Returns:</span></dt><dd>new transaction, parent transaction, or possibly null if required + isolation level is none</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="createTxn(java.lang.Object,com.amazon.carbonado.IsolationLevel,int,java.util.concurrent.TimeUnit)"> +<!-- --> +</a><a name="createTxn(Txn, com.amazon.carbonado.IsolationLevel, int, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createTxn</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> createTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> parent, + <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level, + int timeout, + java.util.concurrent.TimeUnit unit) + throws java.lang.Exception</pre> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction. If parent is not null and real nested transactions are not + supported, simply return parent transaction for supporting fake nested + transactions. + + <p>The default implementation of this method just calls the regular + createTxn method, ignoring the timeout parameter.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - optional parent transaction</dd><dd><code>level</code> - required isolation level</dd><dd><code>timeout</code> - desired timeout for lock acquisition, never negative</dd><dd><code>unit</code> - timeout unit, never null</dd> +<dt><span class="strong">Returns:</span></dt><dd>new transaction, parent transaction, or possibly null if required + isolation level is none</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="reuseTxn(java.lang.Object)"> +<!-- --> +</a><a name="reuseTxn(Txn)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reuseTxn</h4> +<pre>protected void reuseTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn) + throws java.lang.Exception</pre> +<div class="block">Called when a transaction is about to be reused. The default + implementation of this method does nothing. Override if any preparation + is required to ready a transaction for reuse.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - transaction to reuse, never null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.3</dd></dl> +</li> +</ul> +<a name="setForUpdate(java.lang.Object,boolean)"> +<!-- --> +</a><a name="setForUpdate(Txn, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForUpdate</h4> +<pre>protected void setForUpdate(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn, + boolean forUpdate)</pre> +<div class="block">Called when the Transaction.setForUpdate method is called. The default + implementation of this method does nothing. Override if internal + transaction needs to switch modes.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd></dl> +</li> +</ul> +<a name="attachNotification(java.lang.Object)"> +<!-- --> +</a><a name="attachNotification(Txn)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>attachNotification</h4> +<pre>protected void attachNotification(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</pre> +<div class="block">Called to notify internal method that transaction is attached. + The default implementation of this method does nothing. Override if + using remote transactions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - transaction that is attached, could be null if none exists</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</dd></dl> +</li> +</ul> +<a name="detachNotification(java.lang.Object)"> +<!-- --> +</a><a name="detachNotification(Txn)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>detachNotification</h4> +<pre>protected void detachNotification(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn)</pre> +<div class="block">Called to notify internal method that transaction is detached. + The default implementation of this method does nothing. Override if + using remote transactions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - transaction that is dettached, could be null if none exists</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2.2</dd></dl> +</li> +</ul> +<a name="commitTxn(java.lang.Object)"> +<!-- --> +</a><a name="commitTxn(Txn)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitTxn</h4> +<pre>protected abstract boolean commitTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Commits and closes the given internal transaction.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if transaction object is still valid</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="abortTxn(java.lang.Object)"> +<!-- --> +</a><a name="abortTxn(Txn)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>abortTxn</h4> +<pre>protected abstract void abortTxn(<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a> txn) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Aborts and closes the given internal transaction.</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></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/TransactionManager.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionManager.html" target="_top">Frames</a></li> +<li><a href="TransactionManager.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><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> diff --git a/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html b/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html new file mode 100644 index 0000000..95d017e --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionMonitor.html @@ -0,0 +1,239 @@ +<!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>TransactionMonitor (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="TransactionMonitor (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/TransactionMonitor.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/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionMonitor.html" target="_top">Frames</a></li> +<li><a href="TransactionMonitor.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.txn</div> +<h2 title="Interface TransactionMonitor" class="title">Interface TransactionMonitor</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">TransactionMonitor</span></pre> +<div class="block">Is notified as transactions enter and exit. Implementation must be thread-safe.</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/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn"><code>TransactionManager</code></a></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/txn/TransactionMonitor.html#entered(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">entered</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> entered, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent)</code> +<div class="block">Called by a thread which has just entered a transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html#exited(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">exited</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> exited, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> active)</code> +<div class="block">Called by a thread which has just exited a transaction.</div> +</td> +</tr> +</table> +</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="entered(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entered</h4> +<pre>void entered(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> entered, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> parent)</pre> +<div class="block">Called by a thread which has just entered a transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entered</code> - transaction just entered</dd><dd><code>parent</code> - optional parent of transaction; is null for top level transactions</dd></dl> +</li> +</ul> +<a name="exited(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>exited</h4> +<pre>void exited(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> exited, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> active)</pre> +<div class="block">Called by a thread which has just exited a transaction. Only the first + invocation of the exit method is passed to this monitor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>exited</code> - transaction just exited</dd><dd><code>active</code> - optional transaction which is now active; is null if the + outermost transaction scope exited</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/TransactionMonitor.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/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionMonitor.html" target="_top">Frames</a></li> +<li><a href="TransactionMonitor.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> diff --git a/apidocs/com/amazon/carbonado/txn/TransactionPair.html b/apidocs/com/amazon/carbonado/txn/TransactionPair.html new file mode 100644 index 0000000..37080e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionPair.html @@ -0,0 +1,502 @@ +<!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>TransactionPair (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="TransactionPair (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/TransactionPair.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/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionPair.html" target="_top">Frames</a></li> +<li><a href="TransactionPair.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><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.txn</div> +<h2 title="Class TransactionPair" class="title">Class TransactionPair</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.txn.TransactionPair</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/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">TransactionPair</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></pre> +<div class="block">Pairs two transaction together into one. The transaction cannot be atomic, + however. Inconsistencies can result if the primary transaction succeeds in + committing, but the secondary fails. Therefore, the designated primary + transaction should be the one that is more likely to fail. For example, the + primary transaction might rely on the network, but the secondary operates + locally.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Don Schneider, Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/txn/TransactionPair.html#TransactionPair(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">TransactionPair</a></strong>(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> primaryTransaction, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> secondaryTransaction)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#attach()">attach</a></strong>()</code> +<div class="block">Attaches this transaction to the current thread, if it has been + detached.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#commit()">commit</a></strong>()</code> +<div class="block">If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#detach()">detach</a></strong>()</code> +<div class="block">Detaches this transaction from the current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#exit()">exit</a></strong>()</code> +<div class="block">Closes the current transaction, aborting all changes since the last + commit.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#getIsolationLevel()">getIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of this transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#isForUpdate()">isForUpdate</a></strong>()</code> +<div class="block">Returns true if this transaction is in update mode, which is adjusted by + calling <a href="../../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)"><code>Transaction.setForUpdate(boolean)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#preCommit()">preCommit</a></strong>()</code> +<div class="block">Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)">setDesiredLockTimeout</a></strong>(int timeout, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Specify a desired timeout for aquiring locks within this + transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html#setForUpdate(boolean)">setForUpdate</a></strong>(boolean forUpdate)</code> +<div class="block">Set to true to force all read operations within this transaction to + acquire upgradable or write locks.</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> +</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="TransactionPair(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TransactionPair</h4> +<pre>public TransactionPair(<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> primaryTransaction, + <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> secondaryTransaction)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>primaryTransaction</code> - is committed first, exited last</dd><dd><code>secondaryTransaction</code> - is exited first, commited last</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="commit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commit</h4> +<pre>public void commit() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#commit()">Transaction</a></code></strong></div> +<div class="block">If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#commit()">commit</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="exit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exit</h4> +<pre>public void exit() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#exit()">Transaction</a></code></strong></div> +<div class="block">Closes the current transaction, aborting all changes since the last + commit.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#exit()">exit</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></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> - if storage layer throws an exception</dd></dl> +</li> +</ul> +<a name="setForUpdate(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForUpdate</h4> +<pre>public void setForUpdate(boolean forUpdate)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)">Transaction</a></code></strong></div> +<div class="block">Set to true to force all read operations within this transaction to + acquire upgradable or write locks. This option eliminates deadlocks that + may occur when updating records, except it may increase contention.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)">setForUpdate</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></dd> +</dl> +</li> +</ul> +<a name="isForUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isForUpdate</h4> +<pre>public boolean isForUpdate()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#isForUpdate()">Transaction</a></code></strong></div> +<div class="block">Returns true if this transaction is in update mode, which is adjusted by + calling <a href="../../../../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)"><code>Transaction.setForUpdate(boolean)</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#isForUpdate()">isForUpdate</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></dd> +</dl> +</li> +</ul> +<a name="setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDesiredLockTimeout</h4> +<pre>public void setDesiredLockTimeout(int timeout, + java.util.concurrent.TimeUnit unit)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)">Transaction</a></code></strong></div> +<div class="block">Specify a desired timeout for aquiring locks within this + transaction. Calling this method may have have no effect at all, if the + repository does not support this feature. In addition, the lock timeout + might not be alterable if the transaction contains uncommitted data. + + <p>Also, the range of lock timeout values supported might be small. For + example, only a timeout value of zero might be supported. In that case, + the transaction is configured to not wait at all when trying to acquire + locks. Expect immediate timeout exceptions when locks cannot be + granted. + + <p>Nested transactions inherit the desired lock timeout of their + parent. Top transactions always begin with the default lock timeout.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)">setDesiredLockTimeout</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - Desired lock timeout. If negative, revert lock timeout to + default value.</dd><dd><code>unit</code> - Time unit for timeout. If null, revert lock timeout to + default value.</dd></dl> +</li> +</ul> +<a name="getIsolationLevel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIsolationLevel</h4> +<pre>public <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> getIsolationLevel()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#getIsolationLevel()">Transaction</a></code></strong></div> +<div class="block">Returns the isolation level of this transaction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#getIsolationLevel()">getIsolationLevel</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></dd> +</dl> +</li> +</ul> +<a name="detach()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>detach</h4> +<pre>public void detach()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#detach()">Transaction</a></code></strong></div> +<div class="block">Detaches this transaction from the current thread. It can be attached + later, and to any thread which currently has no thread-local + transaction. + + <p>Detaching a transaction also detaches any parent and nested child + transactions. Attaching any of them achieves the same result as + attaching this transaction.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#detach()">detach</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></dd> +</dl> +</li> +</ul> +<a name="attach()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>attach</h4> +<pre>public void attach()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#attach()">Transaction</a></code></strong></div> +<div class="block">Attaches this transaction to the current thread, if it has been + detached. Attaching a transaction also attaches any parent and nested + child transactions.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#attach()">attach</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></dd> +</dl> +</li> +</ul> +<a name="preCommit()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>preCommit</h4> +<pre>public boolean preCommit() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/Transaction.html#preCommit()">Transaction</a></code></strong></div> +<div class="block">Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads. The + commit method must still be called to finish the commit. Most applications + have no use for pre-commit and should only ever call commit. + + <p>The intent of this method is to complete as many operations as + possible leading up to the actual commit. If pre-commit succeeds, then + commit will most likely succeed as well. While in a pre-commit state, the + transaction can still be used by the current thread. Calling pre-commit + again ensures that child transactions and cursors are closed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/Transaction.html#preCommit()">preCommit</a></code> in interface <code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>false if transaction has exited</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> +</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/TransactionPair.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/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionPair.html" target="_top">Frames</a></li> +<li><a href="TransactionPair.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><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> diff --git a/apidocs/com/amazon/carbonado/txn/TransactionScope.html b/apidocs/com/amazon/carbonado/txn/TransactionScope.html new file mode 100644 index 0000000..20f215b --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/TransactionScope.html @@ -0,0 +1,392 @@ +<!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>TransactionScope (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="TransactionScope (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/TransactionScope.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/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionScope.html" target="_top">Frames</a></li> +<li><a href="TransactionScope.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.txn</div> +<h2 title="Class TransactionScope" class="title">Class TransactionScope<Txn></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.txn.TransactionScope<Txn></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>Txn</code> - Transaction implementation</dd></dl> +<hr> +<br> +<pre>public class <span class="strong">TransactionScope<Txn></span> +extends java.lang.Object</pre> +<div class="block">Container of thread local, scoped transactions.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn"><code>TransactionManager</code></a></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/txn/TransactionScope.html#attach()">attach</a></strong>()</code> +<div class="block">Attach this scope to the current thread, if it has been <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#detachLocalScope()"><code>detached</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#enter(com.amazon.carbonado.IsolationLevel)">enter</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enters a new transaction scope which becomes the active transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#enterTop(com.amazon.carbonado.IsolationLevel)">enterTop</a></strong>(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</code> +<div class="block">Enters a new top-level transaction scope which becomes the active + transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#getIsolationLevel()">getIsolationLevel</a></strong>()</code> +<div class="block">Returns the isolation level of the active transaction, or null if there + is no active transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.concurrent.locks.Lock</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#getLock()">getLock</a></strong>()</code> +<div class="block">Returns lock used by TransactionScope.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="type parameter in TransactionScope">Txn</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#getTxn()">getTxn</a></strong>()</code> +<div class="block">Returns the implementation for the active transaction, or null if there + is no active transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#isForUpdate()">isForUpdate</a></strong>()</code> +<div class="block">Returns true if an active transaction exists and it is for update.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#register(java.lang.Class, com.amazon.carbonado.Cursor)">register</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html#unregister(java.lang.Class, com.amazon.carbonado.Cursor)">unregister</a></strong>(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</code> +<div class="block">Unregisters a previously registered cursor.</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> +</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="enter(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enter</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enter(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Enters a new transaction scope which becomes the active transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - desired isolation level (may be null)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if isolation level higher than + supported by repository</dd></dl> +</li> +</ul> +<a name="enterTop(com.amazon.carbonado.IsolationLevel)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enterTop</h4> +<pre>public <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a> enterTop(<a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> level)</pre> +<div class="block">Enters a new top-level transaction scope which becomes the active + transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - desired isolation level (may be null)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - if isolation level higher than + supported by repository</dd></dl> +</li> +</ul> +<a name="register(java.lang.Class, com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>register</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> void register(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</pre> +<div class="block">Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close. If there + is no active transaction in scope, the cursor is registered as not part + of a transaction. Cursors should register when created.</div> +</li> +</ul> +<a name="unregister(java.lang.Class, com.amazon.carbonado.Cursor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unregister</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> void unregister(java.lang.Class<S> type, + <a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><S> cursor)</pre> +<div class="block">Unregisters a previously registered cursor. Cursors should unregister + when closed.</div> +</li> +</ul> +<a name="getLock()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLock</h4> +<pre>public java.util.concurrent.locks.Lock getLock()</pre> +<div class="block">Returns lock used by TransactionScope. While holding lock, operations + are suspended.</div> +</li> +</ul> +<a name="getTxn()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTxn</h4> +<pre>public <a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="type parameter in TransactionScope">Txn</a> getTxn() + throws java.lang.Exception</pre> +<div class="block">Returns the implementation for the active transaction, or null if there + is no active transaction.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - thrown by createTxn or reuseTxn</dd></dl> +</li> +</ul> +<a name="isForUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isForUpdate</h4> +<pre>public boolean isForUpdate()</pre> +<div class="block">Returns true if an active transaction exists and it is for update.</div> +</li> +</ul> +<a name="getIsolationLevel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIsolationLevel</h4> +<pre>public <a href="../../../../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a> getIsolationLevel()</pre> +<div class="block">Returns the isolation level of the active transaction, or null if there + is no active transaction.</div> +</li> +</ul> +<a name="attach()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>attach</h4> +<pre>public void attach()</pre> +<div class="block">Attach this scope to the current thread, if it has been <a href="../../../../com/amazon/carbonado/txn/TransactionManager.html#detachLocalScope()"><code>detached</code></a>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if current thread has a different + transaction already attached</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/TransactionScope.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/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/TransactionScope.html" target="_top">Frames</a></li> +<li><a href="TransactionScope.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> diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html new file mode 100644 index 0000000..5b68ce4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionManager.html @@ -0,0 +1,161 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.txn.TransactionManager (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="Uses of Class com.amazon.carbonado.txn.TransactionManager (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><a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/txn/class-use/TransactionManager.html" target="_top">Frames</a></li> +<li><a href="TransactionManager.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"> +<h2 title="Uses of Class com.amazon.carbonado.txn.TransactionManager" class="title">Uses of Class<br>com.amazon.carbonado.txn.TransactionManager</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a><<a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html#transactionManager()">transactionManager</a></strong>()</code> +<div class="block">Returns the repository's TransactionManager.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/txn/class-use/TransactionManager.html" target="_top">Frames</a></li> +<li><a href="TransactionManager.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> diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html new file mode 100644 index 0000000..b573164 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionMonitor.html @@ -0,0 +1,157 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.txn.TransactionMonitor (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="Uses of Interface com.amazon.carbonado.txn.TransactionMonitor (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><a href="../../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/txn/class-use/TransactionMonitor.html" target="_top">Frames</a></li> +<li><a href="TransactionMonitor.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"> +<h2 title="Uses of Interface com.amazon.carbonado.txn.TransactionMonitor" class="title">Uses of Interface<br>com.amazon.carbonado.txn.TransactionMonitor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a> in <a href="../../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> with parameters of type <a href="../../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html#TransactionManager(com.amazon.carbonado.txn.TransactionMonitor)">TransactionManager</a></strong>(<a href="../../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a> monitor)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/txn/class-use/TransactionMonitor.html" target="_top">Frames</a></li> +<li><a href="TransactionMonitor.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> diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html new file mode 100644 index 0000000..742eea7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionPair.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.txn.TransactionPair (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="Uses of Class com.amazon.carbonado.txn.TransactionPair (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><a href="../../../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/txn/class-use/TransactionPair.html" target="_top">Frames</a></li> +<li><a href="TransactionPair.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"> +<h2 title="Uses of Class com.amazon.carbonado.txn.TransactionPair" class="title">Uses of Class<br>com.amazon.carbonado.txn.TransactionPair</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.txn.TransactionPair</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/txn/class-use/TransactionPair.html" target="_top">Frames</a></li> +<li><a href="TransactionPair.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> diff --git a/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html b/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html new file mode 100644 index 0000000..65c8f0a --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/class-use/TransactionScope.html @@ -0,0 +1,193 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.txn.TransactionScope (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="Uses of Class com.amazon.carbonado.txn.TransactionScope (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><a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/txn/class-use/TransactionScope.html" target="_top">Frames</a></li> +<li><a href="TransactionScope.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"> +<h2 title="Uses of Class com.amazon.carbonado.txn.TransactionScope" class="title">Uses of Class<br>com.amazon.carbonado.txn.TransactionScope</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>></code></td> +<td class="colLast"><span class="strong">AbstractRepository.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/AbstractRepository.html#localTransactionScope()">localTransactionScope</a></strong>()</code> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a> in <a href="../../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> that return <a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>></code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html#detachLocalScope()">detachLocalScope</a></strong>()</code> +<div class="block">Detaches the thread-local TransactionScope from the current thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><<a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>></code></td> +<td class="colLast"><span class="strong">TransactionManager.</span><code><strong><a href="../../../../../com/amazon/carbonado/txn/TransactionManager.html#localScope()">localScope</a></strong>()</code> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/txn/class-use/TransactionScope.html" target="_top">Frames</a></li> +<li><a href="TransactionScope.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> diff --git a/apidocs/com/amazon/carbonado/txn/package-frame.html b/apidocs/com/amazon/carbonado/txn/package-frame.html new file mode 100644 index 0000000..afb6b1a --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-frame.html @@ -0,0 +1,26 @@ +<!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.txn (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/txn/package-summary.html" target="classFrame">com.amazon.carbonado.txn</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="TransactionMonitor.html" title="interface in com.amazon.carbonado.txn" target="classFrame"><i>TransactionMonitor</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="TransactionManager.html" title="class in com.amazon.carbonado.txn" target="classFrame">TransactionManager</a></li> +<li><a href="TransactionPair.html" title="class in com.amazon.carbonado.txn" target="classFrame">TransactionPair</a></li> +<li><a href="TransactionScope.html" title="class in com.amazon.carbonado.txn" target="classFrame">TransactionScope</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/txn/package-summary.html b/apidocs/com/amazon/carbonado/txn/package-summary.html new file mode 100644 index 0000000..8ffb693 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-summary.html @@ -0,0 +1,175 @@ +<!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.txn (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.txn (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><a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/util/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/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.txn</h1> +<div class="docSummary"> +<div class="block">Provides support for managing transactions.</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/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a></td> +<td class="colLast"> +<div class="block">Is notified as transactions enter and exit.</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/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a><Txn></td> +<td class="colLast"> +<div class="block">Generic transaction manager for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></td> +<td class="colLast"> +<div class="block">Pairs two transaction together into one.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a><Txn></td> +<td class="colLast"> +<div class="block">Container of thread local, scoped transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.txn Description">Package com.amazon.carbonado.txn Description</h2> +<div class="block">Provides support for managing transactions.</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><a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/util/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/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> diff --git a/apidocs/com/amazon/carbonado/txn/package-tree.html b/apidocs/com/amazon/carbonado/txn/package-tree.html new file mode 100644 index 0000000..47040ec --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-tree.html @@ -0,0 +1,136 @@ +<!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.txn Class Hierarchy (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.txn Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/synthetic/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/util/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.txn</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.txn.<a href="../../../../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionManager</span></a><Txn></li> +<li type="circle">com.amazon.carbonado.txn.<a href="../../../../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionPair</span></a> (implements com.amazon.carbonado.<a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a>)</li> +<li type="circle">com.amazon.carbonado.txn.<a href="../../../../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionScope</span></a><Txn></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.txn.<a href="../../../../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">TransactionMonitor</span></a></li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/synthetic/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/util/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/txn/package-use.html b/apidocs/com/amazon/carbonado/txn/package-use.html new file mode 100644 index 0000000..eaf68b1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/txn/package-use.html @@ -0,0 +1,187 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.txn (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="Uses of Package com.amazon.carbonado.txn (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.txn" class="title">Uses of Package<br>com.amazon.carbonado.txn</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.txn">com.amazon.carbonado.txn</a></td> +<td class="colLast"> +<div class="block">Provides support for managing transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/txn/class-use/TransactionManager.html#com.amazon.carbonado.spi">TransactionManager</a> +<div class="block">Generic transaction manager for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/txn/class-use/TransactionScope.html#com.amazon.carbonado.spi">TransactionScope</a> +<div class="block">Container of thread local, scoped transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.txn"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> used by <a href="../../../../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/txn/class-use/TransactionMonitor.html#com.amazon.carbonado.txn">TransactionMonitor</a> +<div class="block">Is notified as transactions enter and exit.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/txn/class-use/TransactionScope.html#com.amazon.carbonado.txn">TransactionScope</a> +<div class="block">Container of thread local, scoped transactions.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/txn/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> diff --git a/apidocs/com/amazon/carbonado/util/AbstractPool.html b/apidocs/com/amazon/carbonado/util/AbstractPool.html new file mode 100644 index 0000000..55e0910 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AbstractPool.html @@ -0,0 +1,348 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AbstractPool (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="AbstractPool (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/AbstractPool.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AbstractPool.html" target="_top">Frames</a></li> +<li><a href="AbstractPool.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><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.util</div> +<h2 title="Class AbstractPool" class="title">Class AbstractPool<K,V,E extends java.lang.Exception></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.AbstractPool<K,V,E></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a>, <a href="../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractPool<K,V,E extends java.lang.Exception></span> +extends java.lang.Object</pre> +<div class="block">A concurrent pool of strongly referenced values mapped by key. Values are + lazily created and pooled.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#AbstractPool()">AbstractPool</a></strong>()</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#clear()">clear</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#create(K)">create</a></strong>(<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">K</a> key)</code> +<div class="block">Return a new value instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#get(K)">get</a></strong>(<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">K</a> key)</code> +<div class="block">Returns a value for the given key, which is lazily created and + pooled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object key)</code> +<div class="block">Remove a value, returning the old value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Collection<<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AbstractPool.html#values()">values</a></strong>()</code> +<div class="block">Returns the pool values, which may be concurrently modified.</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> +</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="AbstractPool()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractPool</h4> +<pre>protected AbstractPool()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="get(java.lang.Object)"> +<!-- --> +</a><a name="get(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a> get(<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">K</a> key) + throws <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">E</a> extends java.lang.Exception</pre> +<div class="block">Returns a value for the given key, which is lazily created and + pooled. If multiple threads are requesting upon the same key + concurrently, at most one thread attempts to lazily create the + value. The others wait for it to become available.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">E</a> extends java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="remove(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a> remove(java.lang.Object key)</pre> +<div class="block">Remove a value, returning the old value.</div> +</li> +</ul> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public java.util.Collection<<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a>> values()</pre> +<div class="block">Returns the pool values, which may be concurrently modified.</div> +</li> +</ul> +<a name="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +</li> +</ul> +<a name="create(java.lang.Object)"> +<!-- --> +</a><a name="create(K)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a> create(<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">K</a> key) + throws <a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">E</a> extends java.lang.Exception</pre> +<div class="block">Return a new value instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">E</a> extends java.lang.Exception</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/AbstractPool.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 Class</li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AbstractPool.html" target="_top">Frames</a></li> +<li><a href="AbstractPool.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><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> diff --git a/apidocs/com/amazon/carbonado/util/AnnotationBuilder.html b/apidocs/com/amazon/carbonado/util/AnnotationBuilder.html new file mode 100644 index 0000000..7f6d3c8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationBuilder.html @@ -0,0 +1,934 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AnnotationBuilder (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="AnnotationBuilder (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/AnnotationBuilder.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/util/AbstractPool.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationBuilder.html" target="_top">Frames</a></li> +<li><a href="AnnotationBuilder.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><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.util</div> +<h2 title="Class AnnotationBuilder" class="title">Class AnnotationBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.AnnotationBuilder</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">AnnotationBuilder</span> +extends <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></pre> +<div class="block">Builds all Annotation properties to a Cojen Annotation definition.</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"> +<!-- ======== 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/util/AnnotationBuilder.html#AnnotationBuilder()">AnnotationBuilder</a></strong>()</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>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.annotation.Annotation, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, boolean[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + boolean[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, boolean, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + boolean value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit booleans.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, byte[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + byte[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, byte, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + byte value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, char[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + char[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, char, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + char value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit chars.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.Class[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Class[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.Class, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Class value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit Classes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, double[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + double[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, double, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + double value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit doubles.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.Enum[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Enum[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.Enum, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Enum value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit Enums.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, float[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + float[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, float, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + float value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit floats.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, int[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + int[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, int, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + int value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit ints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, long[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + long[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, long, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + long value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit longs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, short[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + short[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, short, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + short value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit shorts.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.String[], org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.String[] value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.String, org.cojen.classfile.attribute.Annotation)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.String value, + org.cojen.classfile.attribute.Annotation ann)</code> +<div class="block">Override to visit Strings.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.AnnotationVisitor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.annotation.Annotation, P)">visit</a></code></li> +</ul> +<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> +</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="AnnotationBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AnnotationBuilder</h4> +<pre>public AnnotationBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="visit(java.lang.String, int, java.lang.annotation.Annotation, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member or not part of an annotation</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Annotation visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, int, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + int value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit ints.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - int visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, long, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + long value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit longs.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - long visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, float, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + float value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit floats.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - float visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, double, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + double value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit doubles.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - double visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, boolean, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + boolean value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit booleans.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - boolean visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, byte, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + byte value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit bytes.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - byte visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, short, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + short value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit shorts.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - short visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, char, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + char value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit chars.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - char visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.String, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.String value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Strings.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - String visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Class, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Class value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Classes.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Class visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Enum, org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Enum value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Enums.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Enum visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.annotation.Annotation[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Annotation array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, int[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + int[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - int array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, long[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + long[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - long array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, float[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + float[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - float array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, double[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + double[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - double array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, boolean[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + boolean[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - boolean array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, byte[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + byte[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - byte array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, short[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + short[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - short array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, char[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + char[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - char array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.String[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.String[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - String array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Class[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Class[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Class array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Enum[], org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Enum[] value, + org.cojen.classfile.attribute.Annotation ann)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,org.cojen.classfile.attribute.Annotation></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Enum array visited</dd><dd><code>ann</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</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/AnnotationBuilder.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/util/AbstractPool.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationBuilder.html" target="_top">Frames</a></li> +<li><a href="AnnotationBuilder.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><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> diff --git a/apidocs/com/amazon/carbonado/util/AnnotationDescParser.html b/apidocs/com/amazon/carbonado/util/AnnotationDescParser.html new file mode 100644 index 0000000..0b55674 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationDescParser.html @@ -0,0 +1,291 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AnnotationDescParser (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="AnnotationDescParser (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/AnnotationDescParser.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/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationDescParser.html" target="_top">Frames</a></li> +<li><a href="AnnotationDescParser.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><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.util</div> +<h2 title="Class AnnotationDescParser" class="title">Class AnnotationDescParser</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.AnnotationDescParser</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">AnnotationDescParser</span> +extends java.lang.Object</pre> +<div class="block">Parses an annotation descriptor String to a Cojen Annotation definition.</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/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util"><code>AnnotationDescPrinter</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/util/AnnotationDescParser.html#AnnotationDescParser(java.lang.String)">AnnotationDescParser</a></strong>(java.lang.String annotationString)</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>protected org.cojen.classfile.attribute.Annotation</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescParser.html#buildRootAnnotation(org.cojen.classfile.TypeDesc)">buildRootAnnotation</a></strong>(org.cojen.classfile.TypeDesc rootAnnotationType)</code> +<div class="block">Override this method if a root annotation is not provided, as it must be + built after parsing the root annotation type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.attribute.Annotation</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescParser.html#parse(org.cojen.classfile.attribute.Annotation)">parse</a></strong>(org.cojen.classfile.attribute.Annotation rootAnnotation)</code> +<div class="block">Parses the given annotation, returning the root annotation that received + the results.</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> +</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="AnnotationDescParser(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AnnotationDescParser</h4> +<pre>public AnnotationDescParser(java.lang.String annotationString)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>annotationString</code> - annotation to parse</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="parse(org.cojen.classfile.attribute.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public org.cojen.classfile.attribute.Annotation parse(org.cojen.classfile.attribute.Annotation rootAnnotation)</pre> +<div class="block">Parses the given annotation, returning the root annotation that received + the results.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootAnnotation</code> - root annotation</dd> +<dt><span class="strong">Returns:</span></dt><dd>root annotation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>IllegalArgumentExcecption</code> - if annotation is malformed</dd></dl> +</li> +</ul> +<a name="buildRootAnnotation(org.cojen.classfile.TypeDesc)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>buildRootAnnotation</h4> +<pre>protected org.cojen.classfile.attribute.Annotation buildRootAnnotation(org.cojen.classfile.TypeDesc rootAnnotationType)</pre> +<div class="block">Override this method if a root annotation is not provided, as it must be + built after parsing the root annotation type. By default, this method + throws UnsupportedOperationException.</div> +</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/AnnotationDescParser.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/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationDescParser.html" target="_top">Frames</a></li> +<li><a href="AnnotationDescParser.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><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> diff --git a/apidocs/com/amazon/carbonado/util/AnnotationDescPrinter.html b/apidocs/com/amazon/carbonado/util/AnnotationDescPrinter.html new file mode 100644 index 0000000..2d8670d --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationDescPrinter.html @@ -0,0 +1,988 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AnnotationDescPrinter (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="AnnotationDescPrinter (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/AnnotationDescPrinter.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/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationDescPrinter.html" target="_top">Frames</a></li> +<li><a href="AnnotationDescPrinter.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><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.util</div> +<h2 title="Class AnnotationDescPrinter" class="title">Class AnnotationDescPrinter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.AnnotationVisitor</a><java.lang.Object,java.lang.Object></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.AnnotationDescPrinter</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">AnnotationDescPrinter</span> +extends <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></pre> +<div class="block">Prints machine readable, self-describing, annotation descriptors.</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/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util"><code>AnnotationDescParser</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/util/AnnotationDescPrinter.html#AnnotationDescPrinter(boolean, java.lang.StringBuilder)">AnnotationDescPrinter</a></strong>(boolean sort, + java.lang.StringBuilder b)</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>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#makePlainDescriptor(java.lang.Class)">makePlainDescriptor</a></strong>(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)</code> +<div class="block">Returns an annotation descriptor that has no parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#makePlainDescriptor(java.lang.String)">makePlainDescriptor</a></strong>(java.lang.String annotationType)</code> +<div class="block">Returns an annotation descriptor that has no parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.annotation.Annotation)">visit</a></strong>(java.lang.annotation.Annotation value)</code> +<div class="block">Prints the annotation to the builder passed to the constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.annotation.Annotation, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + java.lang.Object param)</code> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, boolean[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + boolean[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, boolean, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + boolean value, + java.lang.Object param)</code> +<div class="block">Override to visit booleans.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, byte[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + byte[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, byte, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + byte value, + java.lang.Object param)</code> +<div class="block">Override to visit bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, char[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + char[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, char, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + char value, + java.lang.Object param)</code> +<div class="block">Override to visit chars.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.Class[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Class[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.Class, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Class value, + java.lang.Object param)</code> +<div class="block">Override to visit Classes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, double[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + double[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, double, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + double value, + java.lang.Object param)</code> +<div class="block">Override to visit doubles.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.Enum[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Enum[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.Enum, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Enum value, + java.lang.Object param)</code> +<div class="block">Override to visit Enums.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, float[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + float[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, float, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + float value, + java.lang.Object param)</code> +<div class="block">Override to visit floats.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, int[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + int[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, int, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + int value, + java.lang.Object param)</code> +<div class="block">Override to visit ints.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, long[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + long[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, long, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + long value, + java.lang.Object param)</code> +<div class="block">Override to visit longs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, short[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + short[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, short, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + short value, + java.lang.Object param)</code> +<div class="block">Override to visit shorts.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.String[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.String[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.String, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.String value, + java.lang.Object param)</code> +<div class="block">Override to visit Strings.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.AnnotationVisitor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.annotation.Annotation, P)">visit</a></code></li> +</ul> +<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> +</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="AnnotationDescPrinter(boolean, java.lang.StringBuilder)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AnnotationDescPrinter</h4> +<pre>public AnnotationDescPrinter(boolean sort, + java.lang.StringBuilder b)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sort</code> - when true, sort annotation members by name (case sensitive)</dd><dd><code>b</code> - StringBuilder to get printed results</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="makePlainDescriptor(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>makePlainDescriptor</h4> +<pre>public static java.lang.String makePlainDescriptor(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)</pre> +<div class="block">Returns an annotation descriptor that has no parameters.</div> +</li> +</ul> +<a name="makePlainDescriptor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>makePlainDescriptor</h4> +<pre>public static java.lang.String makePlainDescriptor(java.lang.String annotationType)</pre> +<div class="block">Returns an annotation descriptor that has no parameters.</div> +</li> +</ul> +<a name="visit(java.lang.annotation.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.annotation.Annotation value)</pre> +<div class="block">Prints the annotation to the builder passed to the constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Annotation to visit</dd> +<dt><span class="strong">Returns:</span></dt><dd>null</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.annotation.Annotation, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member or not part of an annotation</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Annotation visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, int, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + int value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit ints.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - int visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, long, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + long value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit longs.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - long visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, float, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + float value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit floats.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - float visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, double, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + double value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit doubles.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - double visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, boolean, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + boolean value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit booleans.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - boolean visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, byte, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + byte value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit bytes.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - byte visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, short, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + short value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit shorts.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - short visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, char, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + char value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit chars.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - char visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.String, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.String value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Strings.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - String visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Class, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Class value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Classes.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Class visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Enum, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Enum value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Enums.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Enum visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.annotation.Annotation[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Annotation array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, int[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + int[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - int array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, long[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + long[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - long array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, float[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + float[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - float array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, double[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + double[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - double array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, boolean[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + boolean[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - boolean array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, byte[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + byte[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - byte array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, short[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + short[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - short array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, char[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + char[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - char array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.String[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.String[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - String array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Class[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Class[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Class array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Enum[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Enum[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Enum array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</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/AnnotationDescPrinter.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/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationDescPrinter.html" target="_top">Frames</a></li> +<li><a href="AnnotationDescPrinter.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><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> diff --git a/apidocs/com/amazon/carbonado/util/AnnotationPrinter.html b/apidocs/com/amazon/carbonado/util/AnnotationPrinter.html new file mode 100644 index 0000000..ac856d3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationPrinter.html @@ -0,0 +1,956 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AnnotationPrinter (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="AnnotationPrinter (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/AnnotationPrinter.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/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationPrinter.html" target="_top">Frames</a></li> +<li><a href="AnnotationPrinter.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><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.util</div> +<h2 title="Class AnnotationPrinter" class="title">Class AnnotationPrinter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">com.amazon.carbonado.util.AnnotationVisitor</a><java.lang.Object,java.lang.Object></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.AnnotationPrinter</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">AnnotationPrinter</span> +extends <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></pre> +<div class="block">Prints an Annotation into a parseable format, exactly the same as Java + Annotation syntax.</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"> +<!-- ======== 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/util/AnnotationPrinter.html#AnnotationPrinter(boolean, java.lang.StringBuilder)">AnnotationPrinter</a></strong>(boolean sort, + java.lang.StringBuilder b)</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>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.annotation.Annotation)">visit</a></strong>(java.lang.annotation.Annotation value)</code> +<div class="block">Prints the annotation to the builder passed to the constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.annotation.Annotation, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + java.lang.Object param)</code> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, boolean[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + boolean[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, boolean, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + boolean value, + java.lang.Object param)</code> +<div class="block">Override to visit booleans.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, byte[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + byte[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, byte, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + byte value, + java.lang.Object param)</code> +<div class="block">Override to visit bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, char[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + char[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, char, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + char value, + java.lang.Object param)</code> +<div class="block">Override to visit chars.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.Class[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Class[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.Class, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Class value, + java.lang.Object param)</code> +<div class="block">Override to visit Classes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, double[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + double[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, double, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + double value, + java.lang.Object param)</code> +<div class="block">Override to visit doubles.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.Enum[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Enum[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.Enum, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Enum value, + java.lang.Object param)</code> +<div class="block">Override to visit Enums.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, float[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + float[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, float, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + float value, + java.lang.Object param)</code> +<div class="block">Override to visit floats.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, int[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + int[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, int, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + int value, + java.lang.Object param)</code> +<div class="block">Override to visit ints.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, long[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + long[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, long, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + long value, + java.lang.Object param)</code> +<div class="block">Override to visit longs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, short[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + short[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, short, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + short value, + java.lang.Object param)</code> +<div class="block">Override to visit shorts.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.String[], java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.String[] value, + java.lang.Object param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.String, java.lang.Object)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.String value, + java.lang.Object param)</code> +<div class="block">Override to visit Strings.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.AnnotationVisitor"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.annotation.Annotation, P)">visit</a></code></li> +</ul> +<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> +</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="AnnotationPrinter(boolean, java.lang.StringBuilder)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AnnotationPrinter</h4> +<pre>public AnnotationPrinter(boolean sort, + java.lang.StringBuilder b)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sort</code> - when true, sort annotation members by name (case sensitive)</dd><dd><code>b</code> - StringBuilder to get printed results</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="visit(java.lang.annotation.Annotation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.annotation.Annotation value)</pre> +<div class="block">Prints the annotation to the builder passed to the constructor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Annotation to visit</dd> +<dt><span class="strong">Returns:</span></dt><dd>null</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.annotation.Annotation, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member or not part of an annotation</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Annotation visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, int, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + int value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit ints.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - int visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, long, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + long value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit longs.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - long visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, float, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + float value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit floats.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - float visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, double, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + double value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit doubles.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - double visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, boolean, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + boolean value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit booleans.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - boolean visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, byte, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + byte value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit bytes.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - byte visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, short, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + short value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit shorts.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - short visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, char, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + char value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit chars.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - char visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.String, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.String value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Strings.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - String visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Class, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Class value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Classes.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Class visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Enum, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Enum value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum, P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Override to visit Enums.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum, P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Enum visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.annotation.Annotation[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Annotation array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, int[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + int[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - int array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, long[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + long[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - long array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, float[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + float[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - float array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, double[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + double[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - double array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, boolean[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + boolean[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - boolean array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, byte[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + byte[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - byte array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, short[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + short[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - short array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, char[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + char[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - char array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.String[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.String[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - String array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Class[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Class[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Class array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String, int, java.lang.Enum[], java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>visit</h4> +<pre>public java.lang.Object visit(java.lang.String name, + int pos, + java.lang.Enum[] value, + java.lang.Object param)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum[], P)">AnnotationVisitor</a></code></strong></div> +<div class="block">Visits each array element.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum[], P)">visit</a></code> in class <code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><java.lang.Object,java.lang.Object></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Enum array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</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/AnnotationPrinter.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/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationPrinter.html" target="_top">Frames</a></li> +<li><a href="AnnotationPrinter.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><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> diff --git a/apidocs/com/amazon/carbonado/util/AnnotationVisitor.html b/apidocs/com/amazon/carbonado/util/AnnotationVisitor.html new file mode 100644 index 0000000..d50805a --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/AnnotationVisitor.html @@ -0,0 +1,903 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>AnnotationVisitor (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="AnnotationVisitor (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/AnnotationVisitor.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/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationVisitor.html" target="_top">Frames</a></li> +<li><a href="AnnotationVisitor.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><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.util</div> +<h2 title="Class AnnotationVisitor" class="title">Class AnnotationVisitor<R,P></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.AnnotationVisitor<R,P></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a>, <a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a>, <a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">AnnotationVisitor<R,P></span> +extends java.lang.Object</pre> +<div class="block">Generic annotation visitor. Override methods to capture specific elements.</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"> +<!-- ======== 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/util/AnnotationVisitor.html#AnnotationVisitor(boolean)">AnnotationVisitor</a></strong>(boolean sort)</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/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.annotation.Annotation, P)">visit</a></strong>(java.lang.annotation.Annotation value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], P)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation, P)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean[], P)">visit</a></strong>(java.lang.String name, + int pos, + boolean[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean, P)">visit</a></strong>(java.lang.String name, + int pos, + boolean value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit booleans.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte[], P)">visit</a></strong>(java.lang.String name, + int pos, + byte[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte, P)">visit</a></strong>(java.lang.String name, + int pos, + byte value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char[], P)">visit</a></strong>(java.lang.String name, + int pos, + char[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char, P)">visit</a></strong>(java.lang.String name, + int pos, + char value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit chars.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class[], P)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Class[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class, P)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Class value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit Classes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double[], P)">visit</a></strong>(java.lang.String name, + int pos, + double[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double, P)">visit</a></strong>(java.lang.String name, + int pos, + double value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit doubles.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum[], P)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Enum[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum, P)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.Enum value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit Enums.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float[], P)">visit</a></strong>(java.lang.String name, + int pos, + float[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float, P)">visit</a></strong>(java.lang.String name, + int pos, + float value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit floats.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int[], P)">visit</a></strong>(java.lang.String name, + int pos, + int[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int, P)">visit</a></strong>(java.lang.String name, + int pos, + int value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit ints.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long[], P)">visit</a></strong>(java.lang.String name, + int pos, + long[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long, P)">visit</a></strong>(java.lang.String name, + int pos, + long value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit longs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short[], P)">visit</a></strong>(java.lang.String name, + int pos, + short[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short, P)">visit</a></strong>(java.lang.String name, + int pos, + short value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit shorts.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String[], P)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.String[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Visits each array element.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String, P)">visit</a></strong>(java.lang.String name, + int pos, + java.lang.String value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</code> +<div class="block">Override to visit Strings.</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> +</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="AnnotationVisitor(boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AnnotationVisitor</h4> +<pre>public AnnotationVisitor(boolean sort)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sort</code> - when true, sort annotation members by name (case sensitive)</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="visit(java.lang.annotation.Annotation,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.annotation.Annotation, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public final <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.annotation.Annotation value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Initial Annotation to visit</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,java.lang.annotation.Annotation,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, java.lang.annotation.Annotation, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + java.lang.annotation.Annotation value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member or not part of an annotation</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Annotation visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,int,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, int, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + int value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit ints.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - int visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,long,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, long, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + long value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit longs.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - long visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,float,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, float, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + float value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit floats.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - float visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,double,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, double, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + double value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit doubles.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - double visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,boolean,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, boolean, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + boolean value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit booleans.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - boolean visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,byte,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, byte, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + byte value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit bytes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - byte visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,short,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, short, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + short value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit shorts.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - short visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,char,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, char, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + char value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit chars.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - char visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,java.lang.String,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, java.lang.String, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + java.lang.String value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit Strings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - String visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,java.lang.Class,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, java.lang.Class, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + java.lang.Class value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit Classes.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Class visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,java.lang.Enum,java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, java.lang.Enum, P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + java.lang.Enum value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Override to visit Enums.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Enum visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,java.lang.annotation.Annotation[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, java.lang.annotation.Annotation[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + java.lang.annotation.Annotation[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Annotation array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,int[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, int[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + int[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - int array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,long[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, long[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + long[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - long array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,float[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, float[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + float[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - float array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,double[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, double[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + double[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - double array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,boolean[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, boolean[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + boolean[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - boolean array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,byte[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, byte[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + byte[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - byte array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,short[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, short[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + short[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - short array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,char[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, char[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + char[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - char array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,java.lang.String[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, java.lang.String[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + java.lang.String[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - String array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,java.lang.Class[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, java.lang.Class[], P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + java.lang.Class[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Class array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</dd></dl> +</li> +</ul> +<a name="visit(java.lang.String,int,java.lang.Enum[],java.lang.Object)"> +<!-- --> +</a><a name="visit(java.lang.String, int, java.lang.Enum[], P)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>visit</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a> visit(java.lang.String name, + int pos, + java.lang.Enum[] value, + <a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a> param)</pre> +<div class="block">Visits each array element.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - member name, or null if array member</dd><dd><code>pos</code> - position of member in list or array</dd><dd><code>value</code> - Enum array visited</dd><dd><code>param</code> - custom parameter</dd> +<dt><span class="strong">Returns:</span></dt><dd>custom result, null by default</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/AnnotationVisitor.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/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/AnnotationVisitor.html" target="_top">Frames</a></li> +<li><a href="AnnotationVisitor.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><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> diff --git a/apidocs/com/amazon/carbonado/util/Appender.html b/apidocs/com/amazon/carbonado/util/Appender.html new file mode 100644 index 0000000..0f233d4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/Appender.html @@ -0,0 +1,228 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Appender (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="Appender (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/Appender.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/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/Appender.html" target="_top">Frames</a></li> +<li><a href="Appender.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.util</div> +<h2 title="Interface Appender" class="title">Interface Appender</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><S>, <a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><S>, <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a>, <a href="../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a>, <a href="../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a>, <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a>, <a href="../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a>, <a href="../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a>, <a href="../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a>, <a href="../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a>, <a href="../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a>, <a href="../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a>, <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a>, <a href="../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a>, <a href="../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a>, <a href="../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a>, <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Appender</span></pre> +<div class="block">Interface that supports an alternate way of providing a string representation + for an object.</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/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable appendable)</code> +<div class="block">Append the string representation of this object to the given Appendable.</div> +</td> +</tr> +</table> +</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="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>void appendTo(java.lang.Appendable appendable) + throws java.io.IOException</pre> +<div class="block">Append the string representation of this object to the given Appendable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>appendable</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</dd> +<dd><code>java.lang.NullPointerException</code> - if appendable is null</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/Appender.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/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/Appender.html" target="_top">Frames</a></li> +<li><a href="Appender.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> diff --git a/apidocs/com/amazon/carbonado/util/BelatedCreationException.html b/apidocs/com/amazon/carbonado/util/BelatedCreationException.html new file mode 100644 index 0000000..b6e8fe2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/BelatedCreationException.html @@ -0,0 +1,289 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>BelatedCreationException (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="BelatedCreationException (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/BelatedCreationException.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/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/BelatedCreationException.html" target="_top">Frames</a></li> +<li><a href="BelatedCreationException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.util</div> +<h2 title="Class BelatedCreationException" class="title">Class BelatedCreationException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li>java.lang.IllegalStateException</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.BelatedCreationException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">BelatedCreationException</span> +extends java.lang.IllegalStateException</pre> +<div class="block">Exception throw when attempting to perform an unavailable operation on an + object undergoing belated creation.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Jesse Morgan (morganjm)</dd> +<dt><span class="strong">See Also:</span></dt><dd><code>com.amazon.carbonado.util.BelatedCreator;</code>, +<a href="../../../../serialized-form.html#com.amazon.carbonado.util.BelatedCreationException">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/util/BelatedCreationException.html#BelatedCreationException(java.lang.String)">BelatedCreationException</a></strong>(java.lang.String message)</code> +<div class="block">Create a new exception with the given message.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreationException.html#BelatedCreationException(java.lang.String, java.lang.Throwable)">BelatedCreationException</a></strong>(java.lang.String message, + java.lang.Throwable cause)</code> +<div class="block">Create a new exception with the given message and cause.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<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, wait, wait, wait</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="BelatedCreationException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BelatedCreationException</h4> +<pre>public BelatedCreationException(java.lang.String message)</pre> +<div class="block">Create a new exception with the given message.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - The exception message.</dd></dl> +</li> +</ul> +<a name="BelatedCreationException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BelatedCreationException</h4> +<pre>public BelatedCreationException(java.lang.String message, + java.lang.Throwable cause)</pre> +<div class="block">Create a new exception with the given message and cause.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - The exception message.</dd><dd><code>cause</code> - The cause of the exception.</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/BelatedCreationException.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/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/BelatedCreationException.html" target="_top">Frames</a></li> +<li><a href="BelatedCreationException.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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> diff --git a/apidocs/com/amazon/carbonado/util/BelatedCreator.html b/apidocs/com/amazon/carbonado/util/BelatedCreator.html new file mode 100644 index 0000000..c371327 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/BelatedCreator.html @@ -0,0 +1,371 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>BelatedCreator (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="BelatedCreator (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/BelatedCreator.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/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/BelatedCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedCreator.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><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.util</div> +<h2 title="Class BelatedCreator" class="title">Class BelatedCreator<T,E extends java.lang.Exception></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.BelatedCreator<T,E></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a>, <a href="../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">BelatedCreator<T,E extends java.lang.Exception></span> +extends java.lang.Object</pre> +<div class="block">Generic one-shot factory which supports late object creation. If the object + creation results in an exception or is taking too long, the object produced + instead is a bogus one. After retrying, if the real object is created, then + the bogus object turns into a wrapper to the real object. + + <p>Note: If a bogus object is created, the wrapper cannot always be a drop-in + replacement for the real object. If the wrapper is cloned, it won't have the + same behavior as cloning the real object. Also, synchronizing on the wrapper + will not synchronize the real object.</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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#BelatedCreator(java.lang.Class, int)">BelatedCreator</a></strong>(java.lang.Class<<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a>> type, + int minRetryDelayMillis)</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>protected abstract <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">createBogus</a></strong>()</code> +<div class="block">Create instance of bogus object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createdNotification(T)">createdNotification</a></strong>(<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> object)</code> +<div class="block">Notification that createReal has produced the real object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#createReal()">createReal</a></strong>()</code> +<div class="block">Create instance of real object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#get(int)">get</a></strong>(int timeoutMillis)</code> +<div class="block">Returns real or bogus object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">timedOutNotification</a></strong>(long timedOutMillis)</code> +<div class="block">Notification that createReal is taking too long.</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> +</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="BelatedCreator(java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BelatedCreator</h4> +<pre>protected BelatedCreator(java.lang.Class<<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a>> type, + int minRetryDelayMillis)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of object created</dd><dd><code>minRetryDelayMillis</code> - minimum milliseconds to wait before retrying + to create object after failure; if negative, never retry</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null or is not an interface</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="get(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> get(int timeoutMillis) + throws <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception</pre> +<div class="block">Returns real or bogus object. If real object is returned, then future + invocations of this method return the same real object instance. This + method waits for the real object to be created, if it is blocked. If + real object creation fails immediately, then this method will not wait, + returning a bogus object immediately instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeoutMillis</code> - maximum time to wait for real object before + returning bogus one; if negative, potentially wait forever</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>E</code> - exception thrown from createReal</dd> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="createReal()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createReal</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> createReal() + throws <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception</pre> +<div class="block">Create instance of real object. If there is a recoverable error creating + the object, return null. Any error logging must be performed by the + implementation of this method. If null is returned, expect this method + to be called again in the future.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>real object, or null if there was a recoverable error</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>E</code> - unrecoverable error</dd> +<dd><code><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="createBogus()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createBogus</h4> +<pre>protected abstract <a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> createBogus()</pre> +<div class="block">Create instance of bogus object.</div> +</li> +</ul> +<a name="timedOutNotification(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timedOutNotification</h4> +<pre>protected abstract void timedOutNotification(long timedOutMillis)</pre> +<div class="block">Notification that createReal is taking too long. This can be used to log + a message.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timedOutMillis</code> - milliseconds waited before giving up</dd></dl> +</li> +</ul> +<a name="createdNotification(java.lang.Object)"> +<!-- --> +</a><a name="createdNotification(T)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createdNotification</h4> +<pre>protected void createdNotification(<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a> object)</pre> +<div class="block">Notification that createReal has produced the real object. The default + implementation does nothing.</div> +</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/BelatedCreator.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/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/BelatedCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedCreator.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><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> diff --git a/apidocs/com/amazon/carbonado/util/Comparators.html b/apidocs/com/amazon/carbonado/util/Comparators.html new file mode 100644 index 0000000..0f5122d --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/Comparators.html @@ -0,0 +1,270 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Comparators (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="Comparators (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/Comparators.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/util/BelatedCreator.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/Comparators.html" target="_top">Frames</a></li> +<li><a href="Comparators.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><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.util</div> +<h2 title="Class Comparators" class="title">Class Comparators</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.Comparators</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Comparators</span> +extends java.lang.Object</pre> +<div class="block">Collection of utility comparators.</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"> +<!-- ======== 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/util/Comparators.html#Comparators()">Comparators</a></strong>()</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>static <T> java.util.Comparator<T></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Comparators.html#arrayComparator(java.lang.Class, boolean)">arrayComparator</a></strong>(java.lang.Class<T> arrayType, + boolean unsigned)</code> +<div class="block">Returns a comparator which can sort single or multi-dimensional arrays + of primitves or Comparables.</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> +</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="Comparators()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Comparators</h4> +<pre>public Comparators()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="arrayComparator(java.lang.Class, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>arrayComparator</h4> +<pre>public static <T> java.util.Comparator<T> arrayComparator(java.lang.Class<T> arrayType, + boolean unsigned)</pre> +<div class="block">Returns a comparator which can sort single or multi-dimensional arrays + of primitves or Comparables.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>unsigned</code> - applicable only to arrays of bytes, shorts, ints, or longs</dd> +<dt><span class="strong">Returns:</span></dt><dd>null if unsupported</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/Comparators.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/util/BelatedCreator.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/Comparators.html" target="_top">Frames</a></li> +<li><a href="Comparators.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><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> diff --git a/apidocs/com/amazon/carbonado/util/ConversionComparator.html b/apidocs/com/amazon/carbonado/util/ConversionComparator.html new file mode 100644 index 0000000..372fa56 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/ConversionComparator.html @@ -0,0 +1,302 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ConversionComparator (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="ConversionComparator (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/ConversionComparator.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/util/Comparators.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/ConversionComparator.html" target="_top">Frames</a></li> +<li><a href="ConversionComparator.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><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.util</div> +<h2 title="Class ConversionComparator" class="title">Class ConversionComparator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.ConversionComparator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.Comparator<java.lang.Class></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ConversionComparator</span> +extends java.lang.Object +implements java.util.Comparator<java.lang.Class></pre> +<div class="block">Compares type conversions, finding the one that is nearest.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- ======== 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/util/ConversionComparator.html#ConversionComparator(java.lang.Class)">ConversionComparator</a></strong>(java.lang.Class fromType)</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ConversionComparator.html#compare(java.lang.Class, java.lang.Class)">compare</a></strong>(java.lang.Class toType_a, + java.lang.Class toType_b)</code> +<div class="block">Evaluates two types, to see which one is nearest to the from type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ConversionComparator.html#isConversionPossible(java.lang.Class)">isConversionPossible</a></strong>(java.lang.Class toType)</code> +<div class="block">Returns true if a coversion is possible to the given type.</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_java.util.Comparator"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Comparator</h3> +<code>equals</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="ConversionComparator(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConversionComparator</h4> +<pre>public ConversionComparator(java.lang.Class fromType)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isConversionPossible(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isConversionPossible</h4> +<pre>public boolean isConversionPossible(java.lang.Class toType)</pre> +<div class="block">Returns true if a coversion is possible to the given type.</div> +</li> +</ul> +<a name="compare(java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>compare</h4> +<pre>public int compare(java.lang.Class toType_a, + java.lang.Class toType_b)</pre> +<div class="block">Evaluates two types, to see which one is nearest to the from type. + Return <0 if "a" is nearest, 0 if both are equally good, + >0 if "b" is nearest.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>compare</code> in interface <code>java.util.Comparator<java.lang.Class></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/ConversionComparator.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/util/Comparators.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/ConversionComparator.html" target="_top">Frames</a></li> +<li><a href="ConversionComparator.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><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> diff --git a/apidocs/com/amazon/carbonado/util/Converter.html b/apidocs/com/amazon/carbonado/util/Converter.html new file mode 100644 index 0000000..aeb09ee --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/Converter.html @@ -0,0 +1,453 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Converter (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="Converter (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/Converter.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/util/ConversionComparator.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/Converter.html" target="_top">Frames</a></li> +<li><a href="Converter.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><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.util</div> +<h2 title="Class Converter" class="title">Class Converter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.Converter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public abstract class <span class="strong">Converter</span> +extends java.lang.Object</pre> +<div class="block">General purpose type converter. Custom conversions are possible by supplying + an abstract subclass which has public conversion methods whose names begin + with "convert". Each conversion method takes a single argument and returns a + value.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<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"> +<!-- ======== 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/util/Converter.html#Converter()">Converter</a></strong>()</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>static <C extends <a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> <br>C</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#build(java.lang.Class)">build</a></strong>(java.lang.Class<C> converterType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <C extends <a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> <br>java.lang.Class<? extends C></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#buildClass(java.lang.Class)">buildClass</a></strong>(java.lang.Class<C> converterType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.lang.IllegalArgumentException</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#conversionNotSupported(java.lang.Object, java.lang.Class, java.lang.Class)">conversionNotSupported</a></strong>(java.lang.Object fromValue, + java.lang.Class fromType, + java.lang.Class toType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(boolean, java.lang.Class)">convert</a></strong>(boolean from, + java.lang.Class<T> toType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(byte, java.lang.Class)">convert</a></strong>(byte from, + java.lang.Class<T> toType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(char, java.lang.Class)">convert</a></strong>(char from, + java.lang.Class<T> toType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(double, java.lang.Class)">convert</a></strong>(double from, + java.lang.Class<T> toType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(float, java.lang.Class)">convert</a></strong>(float from, + java.lang.Class<T> toType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(int, java.lang.Class)">convert</a></strong>(int from, + java.lang.Class<T> toType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(long, java.lang.Class)">convert</a></strong>(long from, + java.lang.Class<T> toType)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(java.lang.Object, java.lang.Class)">convert</a></strong>(java.lang.Object from, + java.lang.Class<T> toType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Converter.html#convert(short, java.lang.Class)">convert</a></strong>(short from, + java.lang.Class<T> toType)</code> </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> +</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="Converter()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Converter</h4> +<pre>public Converter()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public static <C extends <a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> C build(java.lang.Class<C> converterType)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>converterType</code> - type of converter to generate</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if converter doesn't a no-arg constructor</dd></dl> +</li> +</ul> +<a name="buildClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildClass</h4> +<pre>public static <C extends <a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> java.lang.Class<? extends C> buildClass(java.lang.Class<C> converterType)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>converterType</code> - type of converter to generate</dd></dl> +</li> +</ul> +<a name="convert(java.lang.Object, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(java.lang.Object from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="convert(byte, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(byte from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="convert(short, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(short from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="convert(int, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(int from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="convert(long, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(long from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="convert(float, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(float from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="convert(double, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(double from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="convert(boolean, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(boolean from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="convert(char, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>public abstract <T> T convert(char from, + java.lang.Class<T> toType)</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if conversion is not supported</dd></dl> +</li> +</ul> +<a name="conversionNotSupported(java.lang.Object, java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>conversionNotSupported</h4> +<pre>protected java.lang.IllegalArgumentException conversionNotSupported(java.lang.Object fromValue, + java.lang.Class fromType, + java.lang.Class toType)</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/Converter.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/util/ConversionComparator.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/Converter.html" target="_top">Frames</a></li> +<li><a href="Converter.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><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> diff --git a/apidocs/com/amazon/carbonado/util/QuickConstructorGenerator.html b/apidocs/com/amazon/carbonado/util/QuickConstructorGenerator.html new file mode 100644 index 0000000..5abe8a7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/QuickConstructorGenerator.html @@ -0,0 +1,314 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>QuickConstructorGenerator (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="QuickConstructorGenerator (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/QuickConstructorGenerator.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/util/Converter.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/QuickConstructorGenerator.html" target="_top">Frames</a></li> +<li><a href="QuickConstructorGenerator.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><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.util</div> +<h2 title="Class QuickConstructorGenerator" class="title">Class QuickConstructorGenerator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.QuickConstructorGenerator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <code>QuickConstructorGenerator</code></i></div> +</div> +<br> +<pre>@Deprecated +public class <span class="strong">QuickConstructorGenerator</span> +extends java.lang.Object</pre> +<div class="block">Generates code to invoke constructors. This is a replacement for <code>Constructor</code> which is easier to use and performs + better. In one tested situation, overall performance was improved by about + 10%. + + <p>QuickConstructorGenerator is not general purpose however, as the + parameters to the constructor must be known, and the constructor must be + public. It is intended to be used for constructing instances of + auto-generated classes. The exact parameters may be known at compile time, + but the actual object type is not.</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"> +<!-- ======== 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/util/QuickConstructorGenerator.html#QuickConstructorGenerator()">QuickConstructorGenerator</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </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>static <F> F</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html#getInstance(java.lang.Class, java.lang.Class)">getInstance</a></strong>(java.lang.Class<?> objectType, + java.lang.Class<F> factory)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Returns a factory instance for one type of object.</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> +</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="QuickConstructorGenerator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>QuickConstructorGenerator</h4> +<pre>public QuickConstructorGenerator()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getInstance(java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getInstance</h4> +<pre>public static <F> F getInstance(java.lang.Class<?> objectType, + java.lang.Class<F> factory)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Returns a factory instance for one type of object. Each method in the + interface defines a constructor via its parameters. Any checked + exceptions declared thrown by the constructor must also be declared by + the method. The method return types can be the same type as the + constructed object or a supertype. + + <p>Here is a contrived example for constructing strings. In practice, + such a string factory is is useless, since the "new" operator can be + invoked directly. + + <pre> + public interface StringFactory { + String newEmptyString(); + + String newStringFromChars(char[] chars); + + String newStringFromBytes(byte[] bytes, String charsetName) + throws UnsupportedEncodingException; + } + </pre> + + Here's an example of it being used: + + <pre> + StringFactory sf = QuickConstructorGenerator.getInstance(String.class, StringFactory.class); + ... + String str = sf.newStringFromChars(new char[] {'h', 'e', 'l', 'l', 'o'}); + </pre></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>objectType</code> - type of object to construct</dd><dd><code>factory</code> - interface defining which objects can be constructed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if factory type is not an interface or + if it is malformed</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/QuickConstructorGenerator.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/util/Converter.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/QuickConstructorGenerator.html" target="_top">Frames</a></li> +<li><a href="QuickConstructorGenerator.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><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> diff --git a/apidocs/com/amazon/carbonado/util/SoftValuedCache.html b/apidocs/com/amazon/carbonado/util/SoftValuedCache.html new file mode 100644 index 0000000..387df33 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/SoftValuedCache.html @@ -0,0 +1,478 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>SoftValuedCache (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="SoftValuedCache (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/SoftValuedCache.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/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/SoftValuedCache.html" target="_top">Frames</a></li> +<li><a href="SoftValuedCache.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><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.util</div> +<h2 title="Class SoftValuedCache" class="title">Class SoftValuedCache<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.SoftValuedCache<K,V></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use Cojen <code>Cache</code> interface</i></div> +</div> +<br> +<pre>@Deprecated +public abstract class <span class="strong">SoftValuedCache<K,V></span> +extends java.lang.Object</pre> +<div class="block">Simple thread-safe cache which evicts entries via a shared background + thread. Cache permits null keys, but not null values.</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"> +<!-- ======== 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/util/SoftValuedCache.html#SoftValuedCache()">SoftValuedCache</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </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>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#clear()">clear</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#get(K)">get</a></strong>(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#isEmpty()">isEmpty</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <K,V> <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a><K,V></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#newCache(int)">newCache</a></strong>(int capacity)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#put(K, V)">put</a></strong>(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#putIfAbsent(K, V)">putIfAbsent</a></strong>(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#remove(K)">remove</a></strong>(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#remove(K, V)">remove</a></strong>(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#replace(K, V)">replace</a></strong>(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> value)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#replace(K, V, V)">replace</a></strong>(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> oldValue, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> newValue)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#size()">size</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html#toString()">toString</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </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, wait, wait, wait</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="SoftValuedCache()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SoftValuedCache</h4> +<pre>public SoftValuedCache()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="newCache(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newCache</h4> +<pre>public static <K,V> <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a><K,V> newCache(int capacity)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public abstract int size()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public abstract boolean isEmpty()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="get(java.lang.Object)"> +<!-- --> +</a><a name="get(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> get(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="put(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="put(K, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> put(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="putIfAbsent(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="putIfAbsent(K, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putIfAbsent</h4> +<pre>public abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> putIfAbsent(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="remove(java.lang.Object)"> +<!-- --> +</a><a name="remove(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> remove(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="remove(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="remove(K, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public abstract boolean remove(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="replace(java.lang.Object,java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="replace(K, V, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replace</h4> +<pre>public abstract boolean replace(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> oldValue, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> newValue)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="replace(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="replace(K, V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replace</h4> +<pre>public abstract <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> replace(<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a> key, + <a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a> value)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public abstract void clear()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public abstract java.lang.String toString()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/SoftValuedCache.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/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/SoftValuedCache.html" target="_top">Frames</a></li> +<li><a href="SoftValuedCache.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><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> diff --git a/apidocs/com/amazon/carbonado/util/TaskQueueThread.html b/apidocs/com/amazon/carbonado/util/TaskQueueThread.html new file mode 100644 index 0000000..441eb60 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/TaskQueueThread.html @@ -0,0 +1,402 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>TaskQueueThread (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="TaskQueueThread (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/TaskQueueThread.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/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/TaskQueueThread.html" target="_top">Frames</a></li> +<li><a href="TaskQueueThread.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_classes_inherited_from_class_java.lang.Thread">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_java.lang.Thread">Field</a> | </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.util</div> +<h2 title="Class TaskQueueThread" class="title">Class TaskQueueThread</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Thread</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.TaskQueueThread</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Runnable, java.util.concurrent.Executor</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">TaskQueueThread</span> +extends java.lang.Thread +implements java.util.concurrent.Executor</pre> +<div class="block">Simple generic queue for running tasks from a single thread. Be sure to call + shutdown or interrupt when done using the thread, or else it will never exit.</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_java.lang.Thread"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class java.lang.Thread</h3> +<code>java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler</code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_java.lang.Thread"> +<!-- --> +</a> +<h3>Fields inherited from class java.lang.Thread</h3> +<code>MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY</code></li> +</ul> +</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/util/TaskQueueThread.html#TaskQueueThread(java.lang.String, int)">TaskQueueThread</a></strong>(java.lang.String name, + int queueSize)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#TaskQueueThread(java.lang.String, int, long)">TaskQueueThread</a></strong>(java.lang.String name, + int queueSize, + long timeoutMillis)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#execute(java.lang.Runnable)">execute</a></strong>(java.lang.Runnable task)</code> +<div class="block">Enqueue a task to run.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#execute(java.lang.Runnable, long)">execute</a></strong>(java.lang.Runnable task, + long timeoutMillis)</code> +<div class="block">Enqueue a task to run.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#run()">run</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html#shutdown()">shutdown</a></strong>()</code> +<div class="block">Indicate that this task queue thread should finish running its enqueued + tasks and then exit.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Thread"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Thread</h3> +<code>activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield</code></li> +</ul> +<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>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="TaskQueueThread(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TaskQueueThread</h4> +<pre>public TaskQueueThread(java.lang.String name, + int queueSize)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name to give this thread</dd><dd><code>queueSize</code> - fixed size of queue</dd></dl> +</li> +</ul> +<a name="TaskQueueThread(java.lang.String, int, long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TaskQueueThread</h4> +<pre>public TaskQueueThread(java.lang.String name, + int queueSize, + long timeoutMillis)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name to give this thread</dd><dd><code>queueSize</code> - fixed size of queue</dd><dd><code>timeoutMillis</code> - default maximum time to wait for queue to have an available slot</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="execute(java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute(java.lang.Runnable task) + throws java.util.concurrent.RejectedExecutionException</pre> +<div class="block">Enqueue a task to run.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>execute</code> in interface <code>java.util.concurrent.Executor</code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>task</code> - task to enqueue</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.util.concurrent.RejectedExecutionException</code> - if wait interrupted, timeout expires, + or shutdown has been called</dd></dl> +</li> +</ul> +<a name="execute(java.lang.Runnable, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute(java.lang.Runnable task, + long timeoutMillis) + throws java.util.concurrent.RejectedExecutionException</pre> +<div class="block">Enqueue a task to run.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>task</code> - task to enqueue</dd><dd><code>timeoutMillis</code> - maximum time to wait for queue to have an available slot</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.util.concurrent.RejectedExecutionException</code> - if wait interrupted, timeout expires, + or shutdown has been called</dd></dl> +</li> +</ul> +<a name="shutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>public void shutdown()</pre> +<div class="block">Indicate that this task queue thread should finish running its enqueued + tasks and then exit. Enqueueing new tasks will result in a + RejectedExecutionException being thrown. Join on this thread to wait for + it to exit.</div> +</li> +</ul> +<a name="run()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>run</h4> +<pre>public void run()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>run</code> in interface <code>java.lang.Runnable</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>run</code> in class <code>java.lang.Thread</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/TaskQueueThread.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/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/TaskQueueThread.html" target="_top">Frames</a></li> +<li><a href="TaskQueueThread.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_classes_inherited_from_class_java.lang.Thread">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_java.lang.Thread">Field</a> | </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> diff --git a/apidocs/com/amazon/carbonado/util/Throttle.html b/apidocs/com/amazon/carbonado/util/Throttle.html new file mode 100644 index 0000000..92bb111 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/Throttle.html @@ -0,0 +1,300 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Throttle (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="Throttle (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/Throttle.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/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/Throttle.html" target="_top">Frames</a></li> +<li><a href="Throttle.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><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.util</div> +<h2 title="Class Throttle" class="title">Class Throttle</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.Throttle</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Throttle</span> +extends java.lang.Object</pre> +<div class="block">General purpose class for throttling work relative to its actual measured + performance. To throttle a task, call the throttle method each time a unit + of work has been performed. It computes a rolling average for the amount of + time it takes to perform some work, and then it sleeps a calculated amount + of time to throttle back. + + <p>Instances are intended for use by one thread, and so they are not + thread-safe.</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"> +<!-- ======== 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/util/Throttle.html#Throttle(int)">Throttle</a></strong>(int windowSize)</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>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Throttle.html#main(java.lang.String[])">main</a></strong>(java.lang.String[] args)</code> +<div class="block">Test program which exercises the CPU in an infinite loop, throttled by + the amount given in args[0].</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/Throttle.html#throttle(double, long)">throttle</a></strong>(double desiredSpeed, + long sleepPrecisionMillis)</code> </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> +</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="Throttle(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Throttle</h4> +<pre>public Throttle(int windowSize)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>windowSize</code> - amount of samples to keep in the rolling average</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="throttle(double, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>throttle</h4> +<pre>public void throttle(double desiredSpeed, + long sleepPrecisionMillis) + throws java.lang.InterruptedException</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desiredSpeed</code> - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work</dd><dd><code>sleepPrecisionMillis</code> - sleep precision, in milliseconds. Typical + value is 10 to 100 milliseconds.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code></dd></dl> +</li> +</ul> +<a name="main(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(java.lang.String[] args) + throws java.lang.Exception</pre> +<div class="block">Test program which exercises the CPU in an infinite loop, throttled by + the amount given in args[0]. On a machine performing no other work, the + average CPU load should be about the same as the throttled speed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - args[0] - desired speed, 0.0 to 1.0</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</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/Throttle.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/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/Throttle.html" target="_top">Frames</a></li> +<li><a href="Throttle.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><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> diff --git a/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html b/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html new file mode 100644 index 0000000..3eb5816 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/ThrowUnchecked.html @@ -0,0 +1,495 @@ +<!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:42 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ThrowUnchecked (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="ThrowUnchecked (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/ThrowUnchecked.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/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/ThrowUnchecked.html" target="_top">Frames</a></li> +<li><a href="ThrowUnchecked.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><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.util</div> +<h2 title="Class ThrowUnchecked" class="title">Class ThrowUnchecked</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.util.ThrowUnchecked</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <code>ThrowUnchecked</code> instead</i></div> +</div> +<br> +<pre>public abstract class <span class="strong">ThrowUnchecked</span> +extends java.lang.Object</pre> +<div class="block">Allows exceptions to be thrown which aren't declared to be thrown. Use of + this technique can cause confusion since it violates the Java language rules + for undeclared checked exceptions. For this reason, this class should not be + used except under special circumstances such as to work around compiler + bugs. An exception can be made, if calling any of the fireDeclared methods + and the set of declared types matches what the caller is allowed to throw. + + <p>Example: + + <pre> + public <E extends Throwable> void someMethod(E exception) throws E { + ... + + // Apparent compiler bug sometimes disallows this. Doesn't appear to + // show up when compiling source files individually. + + //throw exception; + + // Throw it this way instead, and compiler doesn't know. + ThrowUnchecked.fire(exception); + } + </pre></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"> +<!-- ======== 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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#ThrowUnchecked()">ThrowUnchecked</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> + </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>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#doFire(java.lang.Throwable)">doFire</a></strong>(java.lang.Throwable t)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fire(java.lang.Throwable)">fire</a></strong>(java.lang.Throwable t)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the given exception, even though it may be checked.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireCause(java.lang.Throwable)">fireCause</a></strong>(java.lang.Throwable t)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the cause of the given exception, even though it may be + checked.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclared(java.lang.Throwable, java.lang.Class...)">fireDeclared</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the given exception if it is unchecked or an instance of any of + the given declared types.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclaredCause(java.lang.Throwable, java.lang.Class...)">fireDeclaredCause</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclaredRootCause(java.lang.Throwable, java.lang.Class...)">fireDeclaredRootCause</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireFirstDeclared(java.lang.Throwable, java.lang.Class...)">fireFirstDeclared</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireFirstDeclaredCause(java.lang.Throwable, java.lang.Class...)">fireFirstDeclaredCause</a></strong>(java.lang.Throwable t, + java.lang.Class... declaredTypes)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the first found cause that matches one of the given declared + types or is unchecked.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html#fireRootCause(java.lang.Throwable)">fireRootCause</a></strong>(java.lang.Throwable t)</code> +<div class="block"><strong>Deprecated.</strong> </div> +<div class="block">Throws the root cause of the given exception, even though it may be + checked.</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> +</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="ThrowUnchecked()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ThrowUnchecked</h4> +<pre>protected ThrowUnchecked()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="fire(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fire</h4> +<pre>public static void fire(java.lang.Throwable t)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the given exception, even though it may be checked. This method + only returns normally if the exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception to throw</dd></dl> +</li> +</ul> +<a name="fireDeclared(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireDeclared</h4> +<pre>public static void fireDeclared(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the given exception if it is unchecked or an instance of any of + the given declared types. Otherwise, it is thrown as an + UndeclaredThrowableException. This method only returns normally if the + exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception to throw</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="fireFirstDeclared(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireFirstDeclared</h4> +<pre>public static void fireFirstDeclared(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked. Otherwise, the + original exception is thrown as an UndeclaredThrowableException. This + method only returns normally if the exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose cause is to be thrown</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="fireCause(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireCause</h4> +<pre>public static void fireCause(java.lang.Throwable t)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the cause of the given exception, even though it may be + checked. If the cause is null, then the original exception is + thrown. This method only returns normally if the exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose cause is to be thrown</dd></dl> +</li> +</ul> +<a name="fireDeclaredCause(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireDeclaredCause</h4> +<pre>public static void fireDeclaredCause(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types. Otherwise, it is thrown as + an UndeclaredThrowableException. If the cause is null, then the original + exception is thrown. This method only returns normally if the exception + is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose cause is to be thrown</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="fireFirstDeclaredCause(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireFirstDeclaredCause</h4> +<pre>public static void fireFirstDeclaredCause(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the first found cause that matches one of the given declared + types or is unchecked. Otherwise, the immediate cause is thrown as an + UndeclaredThrowableException. If the immediate cause is null, then the + original exception is thrown. This method only returns normally if the + exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose cause is to be thrown</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="fireRootCause(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireRootCause</h4> +<pre>public static void fireRootCause(java.lang.Throwable t)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the root cause of the given exception, even though it may be + checked. If the root cause is null, then the original exception is + thrown. This method only returns normally if the exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose root cause is to be thrown</dd></dl> +</li> +</ul> +<a name="fireDeclaredRootCause(java.lang.Throwable, java.lang.Class...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fireDeclaredRootCause</h4> +<pre>public static void fireDeclaredRootCause(java.lang.Throwable t, + java.lang.Class... declaredTypes)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block">Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types. Otherwise, it is thrown as + an UndeclaredThrowableException. If the root cause is null, then the + original exception is thrown. This method only returns normally if the + exception is null.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - exception whose root cause is to be thrown</dd><dd><code>declaredTypes</code> - if exception is checked and is not an instance of + any of these types, then it is thrown as an + UndeclaredThrowableException.</dd></dl> +</li> +</ul> +<a name="doFire(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>doFire</h4> +<pre>protected abstract void doFire(java.lang.Throwable t)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</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/ThrowUnchecked.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/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/ThrowUnchecked.html" target="_top">Frames</a></li> +<li><a href="ThrowUnchecked.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><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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/AbstractPool.html b/apidocs/com/amazon/carbonado/util/class-use/AbstractPool.html new file mode 100644 index 0000000..1a7cd9d --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AbstractPool.html @@ -0,0 +1,190 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.AbstractPool (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="Uses of Class com.amazon.carbonado.util.AbstractPool (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><a href="../../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AbstractPool.html" target="_top">Frames</a></li> +<li><a href="AbstractPool.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.AbstractPool" class="title">Uses of Class<br>com.amazon.carbonado.util.AbstractPool</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a> in <a href="../../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a></strong></code> +<div class="block">A concurrent pool of strongly referenced <a href="../../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceValueProducer</code></a> + instances mapped by name.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></strong></code> +<div class="block">A concurrent pool of strongly referenced Storage instances mapped by + Storable type.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AbstractPool.html" target="_top">Frames</a></li> +<li><a href="AbstractPool.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationBuilder.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationBuilder.html new file mode 100644 index 0000000..d507751 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationBuilder.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.AnnotationBuilder (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="Uses of Class com.amazon.carbonado.util.AnnotationBuilder (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><a href="../../../../../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationBuilder.html" target="_top">Frames</a></li> +<li><a href="AnnotationBuilder.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.AnnotationBuilder" class="title">Uses of Class<br>com.amazon.carbonado.util.AnnotationBuilder</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.AnnotationBuilder</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationBuilder.html" target="_top">Frames</a></li> +<li><a href="AnnotationBuilder.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescParser.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescParser.html new file mode 100644 index 0000000..4d87535 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescParser.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.AnnotationDescParser (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="Uses of Class com.amazon.carbonado.util.AnnotationDescParser (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><a href="../../../../../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationDescParser.html" target="_top">Frames</a></li> +<li><a href="AnnotationDescParser.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.AnnotationDescParser" class="title">Uses of Class<br>com.amazon.carbonado.util.AnnotationDescParser</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.AnnotationDescParser</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationDescParser.html" target="_top">Frames</a></li> +<li><a href="AnnotationDescParser.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html new file mode 100644 index 0000000..66ef665 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.AnnotationDescPrinter (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="Uses of Class com.amazon.carbonado.util.AnnotationDescPrinter (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><a href="../../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html" target="_top">Frames</a></li> +<li><a href="AnnotationDescPrinter.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.AnnotationDescPrinter" class="title">Uses of Class<br>com.amazon.carbonado.util.AnnotationDescPrinter</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.AnnotationDescPrinter</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationDescPrinter.html" target="_top">Frames</a></li> +<li><a href="AnnotationDescPrinter.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationPrinter.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationPrinter.html new file mode 100644 index 0000000..73c334b --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationPrinter.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.AnnotationPrinter (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="Uses of Class com.amazon.carbonado.util.AnnotationPrinter (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><a href="../../../../../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationPrinter.html" target="_top">Frames</a></li> +<li><a href="AnnotationPrinter.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.AnnotationPrinter" class="title">Uses of Class<br>com.amazon.carbonado.util.AnnotationPrinter</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.AnnotationPrinter</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationPrinter.html" target="_top">Frames</a></li> +<li><a href="AnnotationPrinter.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/AnnotationVisitor.html b/apidocs/com/amazon/carbonado/util/class-use/AnnotationVisitor.html new file mode 100644 index 0000000..8adcce4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/AnnotationVisitor.html @@ -0,0 +1,175 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.AnnotationVisitor (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="Uses of Class com.amazon.carbonado.util.AnnotationVisitor (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><a href="../../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationVisitor.html" target="_top">Frames</a></li> +<li><a href="AnnotationVisitor.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.AnnotationVisitor" class="title">Uses of Class<br>com.amazon.carbonado.util.AnnotationVisitor</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.util">com.amazon.carbonado.util</a></td> +<td class="colLast"> +<div class="block">Utilities used by Carbonado but which have no dependencies on + Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.util"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a> in <a href="../../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a> in <a href="../../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></strong></code> +<div class="block">Builds all Annotation properties to a Cojen Annotation definition.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></strong></code> +<div class="block">Prints machine readable, self-describing, annotation descriptors.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></strong></code> +<div class="block">Prints an Annotation into a parseable format, exactly the same as Java + Annotation syntax.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/AnnotationVisitor.html" target="_top">Frames</a></li> +<li><a href="AnnotationVisitor.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/Appender.html b/apidocs/com/amazon/carbonado/util/class-use/Appender.html new file mode 100644 index 0000000..652c5b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/Appender.html @@ -0,0 +1,335 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.util.Appender (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="Uses of Interface com.amazon.carbonado.util.Appender (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><a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/Appender.html" target="_top">Frames</a></li> +<li><a href="Appender.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"> +<h2 title="Uses of Interface com.amazon.carbonado.util.Appender" class="title">Uses of Interface<br>com.amazon.carbonado.util.Appender</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> that implement <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a logical 'and' test.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Base class for filter tree nodes that have a left and right child.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter which blocks any results from passing through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs an existence or non-existence test against a + join property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">An immutable tree structure representing a query result filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Assigns values to <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter which lets all results pass through.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a logical 'or' test.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Filter tree node that performs a relational test against a specific property + value.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that implement <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that implement <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">AbstractQuery implements a small set of common Query methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Special query implementation that fetches nothing.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Abstract query implementation which uses a <a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as needed by JDBCRepository.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/Appender.html" target="_top">Frames</a></li> +<li><a href="Appender.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/BelatedCreationException.html b/apidocs/com/amazon/carbonado/util/class-use/BelatedCreationException.html new file mode 100644 index 0000000..12ec4f2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/BelatedCreationException.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.BelatedCreationException (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="Uses of Class com.amazon.carbonado.util.BelatedCreationException (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><a href="../../../../../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/BelatedCreationException.html" target="_top">Frames</a></li> +<li><a href="BelatedCreationException.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.BelatedCreationException" class="title">Uses of Class<br>com.amazon.carbonado.util.BelatedCreationException</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.BelatedCreationException</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/BelatedCreationException.html" target="_top">Frames</a></li> +<li><a href="BelatedCreationException.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/BelatedCreator.html b/apidocs/com/amazon/carbonado/util/class-use/BelatedCreator.html new file mode 100644 index 0000000..92b0622 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/BelatedCreator.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.BelatedCreator (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="Uses of Class com.amazon.carbonado.util.BelatedCreator (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><a href="../../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/BelatedCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedCreator.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.BelatedCreator" class="title">Uses of Class<br>com.amazon.carbonado.util.BelatedCreator</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></strong></code> +<div class="block">Generic one-shot Repository builder which supports late object creation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Generic one-shot Storage creator which supports late object creation.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/BelatedCreator.html" target="_top">Frames</a></li> +<li><a href="BelatedCreator.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/Comparators.html b/apidocs/com/amazon/carbonado/util/class-use/Comparators.html new file mode 100644 index 0000000..c062f60 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/Comparators.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.Comparators (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="Uses of Class com.amazon.carbonado.util.Comparators (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><a href="../../../../../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/Comparators.html" target="_top">Frames</a></li> +<li><a href="Comparators.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.Comparators" class="title">Uses of Class<br>com.amazon.carbonado.util.Comparators</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.Comparators</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/Comparators.html" target="_top">Frames</a></li> +<li><a href="Comparators.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/ConversionComparator.html b/apidocs/com/amazon/carbonado/util/class-use/ConversionComparator.html new file mode 100644 index 0000000..bc5b448 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/ConversionComparator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.ConversionComparator (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="Uses of Class com.amazon.carbonado.util.ConversionComparator (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><a href="../../../../../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/ConversionComparator.html" target="_top">Frames</a></li> +<li><a href="ConversionComparator.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.ConversionComparator" class="title">Uses of Class<br>com.amazon.carbonado.util.ConversionComparator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.ConversionComparator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/ConversionComparator.html" target="_top">Frames</a></li> +<li><a href="ConversionComparator.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/Converter.html b/apidocs/com/amazon/carbonado/util/class-use/Converter.html new file mode 100644 index 0000000..4a1d4be --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/Converter.html @@ -0,0 +1,164 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.Converter (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="Uses of Class com.amazon.carbonado.util.Converter (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><a href="../../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/Converter.html" target="_top">Frames</a></li> +<li><a href="Converter.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.Converter" class="title">Uses of Class<br>com.amazon.carbonado.util.Converter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.util">com.amazon.carbonado.util</a></td> +<td class="colLast"> +<div class="block">Utilities used by Carbonado but which have no dependencies on + Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.util"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a> in <a href="../../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> with type parameters of type <a href="../../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <C extends <a href="../../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> <br>C</code></td> +<td class="colLast"><span class="strong">Converter.</span><code><strong><a href="../../../../../com/amazon/carbonado/util/Converter.html#build(java.lang.Class)">build</a></strong>(java.lang.Class<C> converterType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <C extends <a href="../../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a>> <br>java.lang.Class<? extends C></code></td> +<td class="colLast"><span class="strong">Converter.</span><code><strong><a href="../../../../../com/amazon/carbonado/util/Converter.html#buildClass(java.lang.Class)">buildClass</a></strong>(java.lang.Class<C> converterType)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/Converter.html" target="_top">Frames</a></li> +<li><a href="Converter.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html b/apidocs/com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html new file mode 100644 index 0000000..c88bd26 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.QuickConstructorGenerator (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="Uses of Class com.amazon.carbonado.util.QuickConstructorGenerator (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><a href="../../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html" target="_top">Frames</a></li> +<li><a href="QuickConstructorGenerator.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.QuickConstructorGenerator" class="title">Uses of Class<br>com.amazon.carbonado.util.QuickConstructorGenerator</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.QuickConstructorGenerator</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/QuickConstructorGenerator.html" target="_top">Frames</a></li> +<li><a href="QuickConstructorGenerator.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/SoftValuedCache.html b/apidocs/com/amazon/carbonado/util/class-use/SoftValuedCache.html new file mode 100644 index 0000000..18f9056 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/SoftValuedCache.html @@ -0,0 +1,162 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.SoftValuedCache (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="Uses of Class com.amazon.carbonado.util.SoftValuedCache (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><a href="../../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/SoftValuedCache.html" target="_top">Frames</a></li> +<li><a href="SoftValuedCache.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.SoftValuedCache" class="title">Uses of Class<br>com.amazon.carbonado.util.SoftValuedCache</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.util">com.amazon.carbonado.util</a></td> +<td class="colLast"> +<div class="block">Utilities used by Carbonado but which have no dependencies on + Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.util"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a> in <a href="../../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> that return <a href="../../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <K,V> <a href="../../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a><K,V></code></td> +<td class="colLast"><span class="strong">SoftValuedCache.</span><code><strong><a href="../../../../../com/amazon/carbonado/util/SoftValuedCache.html#newCache(int)">newCache</a></strong>(int capacity)</code> +<div class="block"><strong>Deprecated.</strong> </div> + </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/SoftValuedCache.html" target="_top">Frames</a></li> +<li><a href="SoftValuedCache.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/TaskQueueThread.html b/apidocs/com/amazon/carbonado/util/class-use/TaskQueueThread.html new file mode 100644 index 0000000..1fc234e --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/TaskQueueThread.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.TaskQueueThread (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="Uses of Class com.amazon.carbonado.util.TaskQueueThread (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><a href="../../../../../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/TaskQueueThread.html" target="_top">Frames</a></li> +<li><a href="TaskQueueThread.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.TaskQueueThread" class="title">Uses of Class<br>com.amazon.carbonado.util.TaskQueueThread</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.TaskQueueThread</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/TaskQueueThread.html" target="_top">Frames</a></li> +<li><a href="TaskQueueThread.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/Throttle.html b/apidocs/com/amazon/carbonado/util/class-use/Throttle.html new file mode 100644 index 0000000..d5f0ce3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/Throttle.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.Throttle (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="Uses of Class com.amazon.carbonado.util.Throttle (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><a href="../../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/Throttle.html" target="_top">Frames</a></li> +<li><a href="Throttle.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.Throttle" class="title">Uses of Class<br>com.amazon.carbonado.util.Throttle</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.Throttle</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/Throttle.html" target="_top">Frames</a></li> +<li><a href="Throttle.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> diff --git a/apidocs/com/amazon/carbonado/util/class-use/ThrowUnchecked.html b/apidocs/com/amazon/carbonado/util/class-use/ThrowUnchecked.html new file mode 100644 index 0000000..4c3b7de --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/class-use/ThrowUnchecked.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.util.ThrowUnchecked (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="Uses of Class com.amazon.carbonado.util.ThrowUnchecked (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><a href="../../../../../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/ThrowUnchecked.html" target="_top">Frames</a></li> +<li><a href="ThrowUnchecked.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"> +<h2 title="Uses of Class com.amazon.carbonado.util.ThrowUnchecked" class="title">Uses of Class<br>com.amazon.carbonado.util.ThrowUnchecked</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.util.ThrowUnchecked</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/util/class-use/ThrowUnchecked.html" target="_top">Frames</a></li> +<li><a href="ThrowUnchecked.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> diff --git a/apidocs/com/amazon/carbonado/util/package-frame.html b/apidocs/com/amazon/carbonado/util/package-frame.html new file mode 100644 index 0000000..21b714e --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/package-frame.html @@ -0,0 +1,42 @@ +<!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.util (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/util/package-summary.html" target="classFrame">com.amazon.carbonado.util</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Appender.html" title="interface in com.amazon.carbonado.util" target="classFrame"><i>Appender</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractPool.html" title="class in com.amazon.carbonado.util" target="classFrame">AbstractPool</a></li> +<li><a href="AnnotationBuilder.html" title="class in com.amazon.carbonado.util" target="classFrame">AnnotationBuilder</a></li> +<li><a href="AnnotationDescParser.html" title="class in com.amazon.carbonado.util" target="classFrame">AnnotationDescParser</a></li> +<li><a href="AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util" target="classFrame">AnnotationDescPrinter</a></li> +<li><a href="AnnotationPrinter.html" title="class in com.amazon.carbonado.util" target="classFrame">AnnotationPrinter</a></li> +<li><a href="AnnotationVisitor.html" title="class in com.amazon.carbonado.util" target="classFrame">AnnotationVisitor</a></li> +<li><a href="BelatedCreator.html" title="class in com.amazon.carbonado.util" target="classFrame">BelatedCreator</a></li> +<li><a href="Comparators.html" title="class in com.amazon.carbonado.util" target="classFrame">Comparators</a></li> +<li><a href="ConversionComparator.html" title="class in com.amazon.carbonado.util" target="classFrame">ConversionComparator</a></li> +<li><a href="Converter.html" title="class in com.amazon.carbonado.util" target="classFrame">Converter</a></li> +<li><a href="QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util" target="classFrame">QuickConstructorGenerator</a></li> +<li><a href="SoftValuedCache.html" title="class in com.amazon.carbonado.util" target="classFrame">SoftValuedCache</a></li> +<li><a href="TaskQueueThread.html" title="class in com.amazon.carbonado.util" target="classFrame">TaskQueueThread</a></li> +<li><a href="Throttle.html" title="class in com.amazon.carbonado.util" target="classFrame">Throttle</a></li> +<li><a href="ThrowUnchecked.html" title="class in com.amazon.carbonado.util" target="classFrame">ThrowUnchecked</a></li> +</ul> +<h2 title="Exceptions">Exceptions</h2> +<ul title="Exceptions"> +<li><a href="BelatedCreationException.html" title="class in com.amazon.carbonado.util" target="classFrame">BelatedCreationException</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/util/package-summary.html b/apidocs/com/amazon/carbonado/util/package-summary.html new file mode 100644 index 0000000..8a6e5fa --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/package-summary.html @@ -0,0 +1,270 @@ +<!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.util (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.util (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><a href="../../../../com/amazon/carbonado/txn/package-summary.html">Prev Package</a></li> +<li>Next Package</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/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.util</h1> +<div class="docSummary"> +<div class="block">Utilities used by Carbonado but which have no dependencies on + 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/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></td> +<td class="colLast"> +<div class="block">Interface that supports an alternate way of providing a string representation + for an object.</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/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a><K,V,E extends java.lang.Exception></td> +<td class="colLast"> +<div class="block">A concurrent pool of strongly referenced values mapped by key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></td> +<td class="colLast"> +<div class="block">Builds all Annotation properties to a Cojen Annotation definition.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util">AnnotationDescParser</a></td> +<td class="colLast"> +<div class="block">Parses an annotation descriptor String to a Cojen Annotation definition.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></td> +<td class="colLast"> +<div class="block">Prints machine readable, self-describing, annotation descriptors.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></td> +<td class="colLast"> +<div class="block">Prints an Annotation into a parseable format, exactly the same as Java + Annotation syntax.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a><R,P></td> +<td class="colLast"> +<div class="block">Generic annotation visitor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a><T,E extends java.lang.Exception></td> +<td class="colLast"> +<div class="block">Generic one-shot factory which supports late object creation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util">Comparators</a></td> +<td class="colLast"> +<div class="block">Collection of utility comparators.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util">ConversionComparator</a></td> +<td class="colLast"> +<div class="block">Compares type conversions, finding the one that is nearest.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></td> +<td class="colLast"> +<div class="block">General purpose type converter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util">QuickConstructorGenerator</a></td> +<td class="colLast">Deprecated +<div class="block"><i>use <code>QuickConstructorGenerator</code></i></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a><K,V></td> +<td class="colLast">Deprecated +<div class="block"><i>use Cojen <code>Cache</code> interface</i></div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></td> +<td class="colLast"> +<div class="block">Simple generic queue for running tasks from a single thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util">Throttle</a></td> +<td class="colLast"> +<div class="block">General purpose class for throttling work relative to its actual measured + performance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></td> +<td class="colLast">Deprecated +<div class="block"><i>use <code>ThrowUnchecked</code> instead</i></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/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util">BelatedCreationException</a></td> +<td class="colLast"> +<div class="block">Exception throw when attempting to perform an unavailable operation on an + object undergoing belated creation.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.util Description">Package com.amazon.carbonado.util Description</h2> +<div class="block">Utilities used by Carbonado but which have no dependencies on + Carbonado. These utilities are candidates for moving into another project.</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><a href="../../../../com/amazon/carbonado/txn/package-summary.html">Prev Package</a></li> +<li>Next Package</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/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> diff --git a/apidocs/com/amazon/carbonado/util/package-tree.html b/apidocs/com/amazon/carbonado/util/package-tree.html new file mode 100644 index 0000000..e907ddf --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/package-tree.html @@ -0,0 +1,172 @@ +<!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.util Class Hierarchy (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.util Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/txn/package-tree.html">Prev</a></li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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 class="title">Hierarchy For Package com.amazon.carbonado.util</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util"><span class="strong">AbstractPool</span></a><K,V,E></li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationDescParser</span></a></li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationVisitor</span></a><R,P> +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationBuilder</span></a></li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationDescPrinter</span></a></li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationPrinter</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util"><span class="strong">BelatedCreator</span></a><T,E></li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util"><span class="strong">Comparators</span></a></li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util"><span class="strong">ConversionComparator</span></a> (implements java.util.Comparator<T>)</li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util"><span class="strong">Converter</span></a></li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">QuickConstructorGenerator</span></a></li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util"><span class="strong">SoftValuedCache</span></a><K,V></li> +<li type="circle">java.lang.Thread (implements java.lang.Runnable) +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util"><span class="strong">TaskQueueThread</span></a> (implements java.util.concurrent.Executor)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Throttle</span></a></li> +<li type="circle">java.lang.Throwable (implements java.io.Serializable) +<ul> +<li type="circle">java.lang.Exception +<ul> +<li type="circle">java.lang.RuntimeException +<ul> +<li type="circle">java.lang.IllegalStateException +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util"><span class="strong">BelatedCreationException</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util"><span class="strong">ThrowUnchecked</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Appender</span></a></li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/txn/package-tree.html">Prev</a></li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/util/package-use.html b/apidocs/com/amazon/carbonado/util/package-use.html new file mode 100644 index 0000000..1deec12 --- /dev/null +++ b/apidocs/com/amazon/carbonado/util/package-use.html @@ -0,0 +1,316 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.util (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="Uses of Package com.amazon.carbonado.util (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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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="Uses of Package com.amazon.carbonado.util" class="title">Uses of Package<br>com.amazon.carbonado.util</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.sequence">com.amazon.carbonado.sequence</a></td> +<td class="colLast"> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.util">com.amazon.carbonado.util</a></td> +<td class="colLast"> +<div class="block">Utilities used by Carbonado but which have no dependencies on + Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> used by <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/Appender.html#com.amazon.carbonado.filter">Appender</a> +<div class="block">Interface that supports an alternate way of providing a string representation + for an object.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> used by <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/Appender.html#com.amazon.carbonado.info">Appender</a> +<div class="block">Interface that supports an alternate way of providing a string representation + for an object.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> used by <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/Appender.html#com.amazon.carbonado.qe">Appender</a> +<div class="block">Interface that supports an alternate way of providing a string representation + for an object.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/Appender.html#com.amazon.carbonado.repo.jdbc">Appender</a> +<div class="block">Interface that supports an alternate way of providing a string representation + for an object.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.sequence"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> used by <a href="../../../../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/AbstractPool.html#com.amazon.carbonado.sequence">AbstractPool</a> +<div class="block">A concurrent pool of strongly referenced values mapped by key.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/AbstractPool.html#com.amazon.carbonado.spi">AbstractPool</a> +<div class="block">A concurrent pool of strongly referenced values mapped by key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/BelatedCreator.html#com.amazon.carbonado.spi">BelatedCreator</a> +<div class="block">Generic one-shot factory which supports late object creation.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.util"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> used by <a href="../../../../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/AnnotationVisitor.html#com.amazon.carbonado.util">AnnotationVisitor</a> +<div class="block">Generic annotation visitor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/Converter.html#com.amazon.carbonado.util">Converter</a> +<div class="block">General purpose type converter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/util/class-use/SoftValuedCache.html#com.amazon.carbonado.util">SoftValuedCache</a> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use Cojen <code>Cache</code> interface</i></div> +</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</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><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/util/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> |