From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- apidocs/index-files/index-6.html | 588 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 588 insertions(+) create mode 100644 apidocs/index-files/index-6.html (limited to 'apidocs/index-files/index-6.html') diff --git a/apidocs/index-files/index-6.html b/apidocs/index-files/index-6.html new file mode 100644 index 0000000..46aa04c --- /dev/null +++ b/apidocs/index-files/index-6.html @@ -0,0 +1,588 @@ + + + + + + +F-Index (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+ + +
A B C D E F G H I J K L M N O P Q R S T U V W Y  + + +

F

+
+
failedDelete(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called when a delete operation failed because an exception was + thrown.
+
+
failedDelete(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
failedDelete(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called when an delete operation failed because the record was missing or + an exception was thrown.
+
+
failedInsert(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called when an insert operation failed because an exception was + thrown.
+
+
failedInsert(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
failedInsert(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called when an insert operation failed due to a unique constraint + violation or an exception was thrown.
+
+
failedUpdate(S, Object) - Method in class com.amazon.carbonado.capability.ResyncCapability.Listener
+
+
Called when an update operation failed because an exception was + thrown.
+
+
failedUpdate(S, Object) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
failedUpdate(S, Object) - Method in class com.amazon.carbonado.Trigger
+
+
Called when an update operation failed because the record was missing or + an exception was thrown.
+
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
fetch() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns an EmptyCursor.
+
+
fetch(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns an EmptyCursor.
+
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.FilteredQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.FilteredQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.IterableQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.IterableQueryExecutor
+
 
+
fetch(FilterValues<T>) - Method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
 
+
fetch(FilterValues<T>, Query.Controller) - Method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.KeyQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.KeyQueryExecutor
+
 
+
fetch(FilterValues<S>) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns a new cursor using the given filter values.
+
+
fetch(FilterValues<S>, Query.Controller) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns a new cursor using the given filter values.
+
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
fetch() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
fetch(Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
fetch(FilterValues<S>) - Method in class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
fetch(FilterValues<S>, Query.Controller) - Method in class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
fetch() - Method in interface com.amazon.carbonado.Query
+
+
Fetches results for this query.
+
+
fetch(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Fetches results for this query.
+
+
FETCH_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Query API method name
+
+
fetchAfter(T) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
fetchAfter(T, Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
fetchAfter(T) - Method in interface com.amazon.carbonado.Query
+
+
Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.
+
+
fetchAfter(T, Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.
+
+
FetchAheadCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Cursor implementation which fetches records in advance, in order to release locks.
+
+
FetchAheadCursor(Cursor<S>, int) - Constructor for class com.amazon.carbonado.cursor.FetchAheadCursor
+
 
+
fetchAll() - Method in interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support
+
+
Perform a full scan of all Storables.
+
+
fetchAll(Query.Controller) - Method in interface com.amazon.carbonado.qe.FullScanQueryExecutor.Support
+
+
Perform a full scan of all Storables.
+
+
FetchDeadlockException - Exception in com.amazon.carbonado
+
+
Thrown if a fetch operation fails because it was selected to resolve a + deadlock.
+
+
FetchDeadlockException() - Constructor for exception com.amazon.carbonado.FetchDeadlockException
+
 
+
FetchDeadlockException(String) - Constructor for exception com.amazon.carbonado.FetchDeadlockException
+
 
+
FetchDeadlockException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchDeadlockException
+
 
+
FetchDeadlockException(Throwable) - Constructor for exception com.amazon.carbonado.FetchDeadlockException
+
 
+
FetchException - Exception in com.amazon.carbonado
+
+
A FetchException is caused by a failure when selecting records from a Repository.
+
+
FetchException() - Constructor for exception com.amazon.carbonado.FetchException
+
 
+
FetchException(String) - Constructor for exception com.amazon.carbonado.FetchException
+
 
+
FetchException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchException
+
 
+
FetchException(Throwable) - Constructor for exception com.amazon.carbonado.FetchException
+
 
+
fetchFromIndexEntryQuery(StorableIndex<S>, Query<?>) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Fetch Storables referenced by the given index entry query.
+
+
fetchFromIndexEntryQuery(StorableIndex<S>, Query<?>, Query.Controller) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Fetch Storables referenced by the given index entry query.
+
+
FetchInterruptedException - Exception in com.amazon.carbonado
+
+
Thrown from a fetch operation that was canceled.
+
+
FetchInterruptedException() - Constructor for exception com.amazon.carbonado.FetchInterruptedException
+
 
+
FetchInterruptedException(String) - Constructor for exception com.amazon.carbonado.FetchInterruptedException
+
 
+
FetchInterruptedException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchInterruptedException
+
 
+
FetchInterruptedException(Throwable) - Constructor for exception com.amazon.carbonado.FetchInterruptedException
+
 
+
FetchMultipleException - Exception in com.amazon.carbonado
+
+
A FetchMultipleException is thrown when a fetch operation returned more + than one record when at most one was expected.
+
+
FetchMultipleException() - Constructor for exception com.amazon.carbonado.FetchMultipleException
+
 
+
FetchMultipleException(String) - Constructor for exception com.amazon.carbonado.FetchMultipleException
+
 
+
FetchMultipleException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchMultipleException
+
 
+
FetchMultipleException(Throwable) - Constructor for exception com.amazon.carbonado.FetchMultipleException
+
 
+
FetchNoneException - Exception in com.amazon.carbonado
+
+
A FetchNoneException is thrown when a fetch operation returned no records + when at least one was expected.
+
+
FetchNoneException() - Constructor for exception com.amazon.carbonado.FetchNoneException
+
 
+
FetchNoneException(String) - Constructor for exception com.amazon.carbonado.FetchNoneException
+
 
+
FetchNoneException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchNoneException
+
 
+
FetchNoneException(Throwable) - Constructor for exception com.amazon.carbonado.FetchNoneException
+
 
+
fetchOne(StorableIndex<S>, Object[]) - Method in interface com.amazon.carbonado.qe.KeyQueryExecutor.Support
+
+
Select at most one Storable referenced by an index.
+
+
fetchOne(StorableIndex<S>, Object[], Query.Controller) - Method in interface com.amazon.carbonado.qe.KeyQueryExecutor.Support
+
+
Select at most one Storable referenced by an index.
+
+
fetchReply() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Executes the call and receive a reply.
+
+
fetchSlice(FilterValues<S>, long, Long) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Produces a slice via skip and limit cursors.
+
+
fetchSlice(FilterValues<S>, long, Long, Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Produces a slice via skip and limit cursors.
+
+
fetchSlice(FilterValues<S>, long, Long) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
fetchSlice(FilterValues<S>, long, Long, Query.Controller) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
fetchSlice(long, Long) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns an EmptyCursor.
+
+
fetchSlice(long, Long, Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns an EmptyCursor.
+
+
fetchSlice(FilterValues<S>, long, Long) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns a new cursor using the given filter values and slice.
+
+
fetchSlice(FilterValues<S>, long, Long, Query.Controller) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Returns a new cursor using the given filter values and slice.
+
+
fetchSlice(long, Long) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
fetchSlice(long, Long, Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
fetchSlice(long, Long) - Method in interface com.amazon.carbonado.Query
+
+
Fetches a slice of results for this query, as defined by a numerical + range.
+
+
fetchSlice(long, Long, Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Fetches a slice of results for this query, as defined by a numerical + range.
+
+
fetchSubset(StorableIndex<S>, Object[], BoundaryType, Object, BoundaryType, Object, boolean, boolean) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Perform an index scan of a subset of Storables referenced by an + index.
+
+
fetchSubset(StorableIndex<S>, Object[], BoundaryType, Object, BoundaryType, Object, boolean, boolean, Query.Controller) - Method in interface com.amazon.carbonado.qe.IndexedQueryExecutor.Support
+
+
Perform an index scan of a subset of Storables referenced by an + index.
+
+
FetchTimeoutException - Exception in com.amazon.carbonado
+
+
Thrown if a fetch operation fails because lock acquisition timed out.
+
+
FetchTimeoutException() - Constructor for exception com.amazon.carbonado.FetchTimeoutException
+
 
+
FetchTimeoutException(String) - Constructor for exception com.amazon.carbonado.FetchTimeoutException
+
 
+
FetchTimeoutException(String, Throwable) - Constructor for exception com.amazon.carbonado.FetchTimeoutException
+
 
+
FetchTimeoutException(Throwable) - Constructor for exception com.amazon.carbonado.FetchTimeoutException
+
 
+
FileBlob - Class in com.amazon.carbonado.lob
+
+
Implementation of a Blob which is backed by a File.
+
+
FileBlob(File) - Constructor for class com.amazon.carbonado.lob.FileBlob
+
 
+
fillInStackTrace() - Method in exception com.amazon.carbonado.Trigger.Abort
+
+
Override to remove the stack trace.
+
+
Filter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
An immutable tree structure representing a query result filter.
+
+
Filter.NotJoined - Class in com.amazon.carbonado.filter
+
+ +
+
FilteredCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps another cursor and applies custom filtering to reduce the set of + results.
+
+
FilteredCursor(Cursor<S>) - Constructor for class com.amazon.carbonado.cursor.FilteredCursor
+
 
+
FilteredQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which wraps another and filters results.
+
+
FilteredQueryExecutor(QueryExecutor<S>, Filter<S>) - Constructor for class com.amazon.carbonado.qe.FilteredQueryExecutor
+
 
+
filterFor(Class<S>, String) - Static method in class com.amazon.carbonado.filter.Filter
+
+
Returns a cached filter instance that operates on the given type and + filter expression.
+
+
FilteringScore<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
Evaluates an index for how well it matches a query's desired filtering.
+
+
FilterValues<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Assigns values to Filter placeholders.
+
+
findAdaptMethod(Class, Class) - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns an adapt method that supports the given conversion, or null if + none.
+
+
findAdaptMethodsFrom(Class) - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns all the adapt methods that convert from the given type.
+
+
findAdaptMethodsTo(Class) - Method in class com.amazon.carbonado.info.StorablePropertyAdapter
+
+
Returns all the adapt methods that convert to the given type.
+
+
findKeyIndex(StorableKey<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Finds the best index to represent the given key.
+
+
findPrimaryKeyIndex(StorableInfo<S>) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Finds the best index to represent the primary key.
+
+
finish() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Finish the reply.
+
+
finish() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Request
+
+
Reply and immediately finish, without sending any data to caller.
+
+
finishGroup() - Method in class com.amazon.carbonado.cursor.GroupedCursor
+
+
This method is called when a group is finished, and it can return an + aggregate.
+
+
fire(Throwable) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the given exception, even though it may be checked.
+
+
fireCause(Throwable) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the cause of the given exception, even though it may be + checked.
+
+
fireDeclared(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the given exception if it is unchecked or an instance of any of + the given declared types.
+
+
fireDeclaredCause(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types.
+
+
fireDeclaredRootCause(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types.
+
+
fireFirstDeclared(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked.
+
+
fireFirstDeclaredCause(Throwable, Class...) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the first found cause that matches one of the given declared + types or is unchecked.
+
+
fireRootCause(Throwable) - Static method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
Throws the root cause of the given exception, even though it may be + checked.
+
+
FloatConstraint - Annotation Type in com.amazon.carbonado.constraint
+
+
Limits the value of a property to be a member of a specific set.
+
+
FloatConstraint.Constraint - Class in com.amazon.carbonado.constraint
+
+
Constraint implementation for FloatConstraint.
+
+
FloatConstraint.Constraint(Class<?>, String, FloatConstraint) - Constructor for class com.amazon.carbonado.constraint.FloatConstraint.Constraint
+
 
+
FloatConstraint.Constraint(Class<?>, String, double, double, double[], double[]) - Constructor for class com.amazon.carbonado.constraint.FloatConstraint.Constraint
+
 
+
flush() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Flushes all the data sent so far.
+
+
flush() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Flushes all the data sent so far.
+
+
forceCheckpoint() - Method in interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability
+
+
Forces a checkpoint to run now, even if checkpointer is suspended or + disabled.
+
+
forString(String) - Static method in enum com.amazon.carbonado.repo.sleepycat.BDBProduct
+
 
+
from(Class<S>) - Static method in class com.amazon.carbonado.gen.StorableCopier
+
 
+
fromCharacter(char) - Static method in enum com.amazon.carbonado.info.Direction
+
+
Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.
+
+
fullComparator() - Static method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns a comparator which determines which CompositeScores are + better.
+
+
fullComparator(QueryHints) - Static method in class com.amazon.carbonado.qe.CompositeScore
+
+
Returns a comparator which determines which CompositeScores are + better.
+
+
fullComparator() - Static method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns a comparator which determines which FilteringScores are + better.
+
+
fullComparator() - Static method in class com.amazon.carbonado.qe.OrderingScore
+
+
Returns a comparator which determines which OrderingScores are + better.
+
+
FullScanQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which fully scans all Storables of a given type.
+
+
FullScanQueryExecutor(FullScanQueryExecutor.Support<S>) - Constructor for class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
FullScanQueryExecutor.Support<S extends Storable> - Interface in com.amazon.carbonado.qe
+
+
Provides support for FullScanQueryExecutor.
+
+
+A B C D E F G H I J K L M N O P Q R S T U V W Y 
+ +
+ + + + + +
+ + +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3