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-20.html | 611 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 611 insertions(+) create mode 100644 apidocs/index-files/index-20.html (limited to 'apidocs/index-files/index-20.html') diff --git a/apidocs/index-files/index-20.html b/apidocs/index-files/index-20.html new file mode 100644 index 0000000..df53699 --- /dev/null +++ b/apidocs/index-files/index-20.html @@ -0,0 +1,611 @@ + + + + + + +T-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  + + +

T

+
+
tail() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.
+
+
TaskQueueThread - Class in com.amazon.carbonado.util
+
+
Simple generic queue for running tasks from a single thread.
+
+
TaskQueueThread(String, int) - Constructor for class com.amazon.carbonado.util.TaskQueueThread
+
 
+
TaskQueueThread(String, int, long) - Constructor for class com.amazon.carbonado.util.TaskQueueThread
+
 
+
TextAdapter - Annotation Type in com.amazon.carbonado.adapter
+
+
Converts database Blobs and Clobs to Strings.
+
+
TextAdapter.Adapter - Class in com.amazon.carbonado.adapter
+
+
Adapter implementation for TextAdapter.
+
+
TextAdapter.Adapter(Class<?>, String, TextAdapter) - Constructor for class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
TextAdapter.Adapter(Class<?>, String, String) - Constructor for class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
TextAdapter.Adapter(Class<?>, String, Charset) - Constructor for class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
TextAdapter.Adapter(Class<?>, String, Charset, Charset[]) - Constructor for class com.amazon.carbonado.adapter.TextAdapter.Adapter
+
 
+
TextConstraint - Annotation Type in com.amazon.carbonado.constraint
+
+
Limits the value of a property to be a member of a specific set.
+
+
TextConstraint.Constraint - Class in com.amazon.carbonado.constraint
+
+
Constraint implementation for TextConstraint.
+
+
TextConstraint.Constraint(Class<?>, String, TextConstraint) - Constructor for class com.amazon.carbonado.constraint.TextConstraint.Constraint
+
 
+
TextConstraint.Constraint(Class<?>, String, String[], String[]) - Constructor for class com.amazon.carbonado.constraint.TextConstraint.Constraint
+
 
+
the() - Static method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Returns the empty cursor instance.
+
+
Throttle - Class in com.amazon.carbonado.util
+
+
General purpose class for throttling work relative to its actual measured + performance.
+
+
Throttle(int) - Constructor for class com.amazon.carbonado.util.Throttle
+
 
+
throttle(double, long) - Method in class com.amazon.carbonado.util.Throttle
+
 
+
ThrottledCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps another cursor and fetches results at a reduced speed.
+
+
ThrottledCursor(Cursor<S>, double) - Constructor for class com.amazon.carbonado.cursor.ThrottledCursor
+
 
+
throwConcatException(CodeBuilder, Class, String...) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generate code to throw an exception with a message concatenated at runtime.
+
+
throwException(CodeBuilder, Class, String) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Generate code to throw an exception with an optional message.
+
+
ThrowUnchecked - Class in com.amazon.carbonado.util
+
+
Deprecated. +
use ThrowUnchecked instead
+
+
+
ThrowUnchecked() - Constructor for class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
timedOutNotification(long) - Method in class com.amazon.carbonado.spi.BelatedRepositoryCreator
+
 
+
timedOutNotification(long) - Method in class com.amazon.carbonado.spi.BelatedStorageCreator
+
 
+
timedOutNotification(long) - Method in class com.amazon.carbonado.util.BelatedCreator
+
+
Notification that createReal is taking too long.
+
+
to(Class<T>) - Method in class com.amazon.carbonado.gen.StorableCopier.From
+
 
+
TO_STRING_KEY_ONLY_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
TO_STRING_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
toCharacter() - Method in enum com.amazon.carbonado.info.Direction
+
+
Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.
+
+
toFetchException(Throwable) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Transforms the given throwable into an appropriate fetch exception.
+
+
toFetchException() - Method in exception com.amazon.carbonado.RepositoryException
+
+
Converts RepositoryException into an appropriate FetchException.
+
+
toFetchException(String) - Method in exception com.amazon.carbonado.RepositoryException
+
+
Converts RepositoryException into an appropriate FetchException, prepending + the specified message.
+
+
toFetchException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Transforms the given throwable into an appropriate fetch exception.
+
+
toFirst() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the first available entry.
+
+
toFirst(byte[]) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the first available entry at or after the given + key.
+
+
toLast() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the last available entry.
+
+
toLast(byte[]) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the last available entry at or before the given + key.
+
+
toList() - Method in class com.amazon.carbonado.cursor.AbstractCursor
+
 
+
toList(int) - Method in class com.amazon.carbonado.cursor.AbstractCursor
+
 
+
toList() - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Always returns an empty list.
+
+
toList(int) - Method in class com.amazon.carbonado.cursor.EmptyCursor
+
+
Always returns an empty list.
+
+
toList() - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
toList(int) - Method in class com.amazon.carbonado.cursor.SingletonCursor
+
 
+
toList() - Method in interface com.amazon.carbonado.Cursor
+
+
Copies all remaining next elements into a new modifiable list.
+
+
toList(int) - Method in interface com.amazon.carbonado.Cursor
+
+
Copies a limited amount of remaining next elements into a new modifiable + list.
+
+
toNext() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the next available entry, returning false if none.
+
+
toNext(int) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the next available entry, incrementing by the amount + given.
+
+
toNextKey() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the next unique key, returning false if none.
+
+
toPersistException(Throwable) - Method in interface com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability
+
+
Transforms the given throwable into an appropriate persist exception.
+
+
toPersistException() - Method in exception com.amazon.carbonado.RepositoryException
+
+
Converts RepositoryException into an appropriate PersistException.
+
+
toPersistException(String) - Method in exception com.amazon.carbonado.RepositoryException
+
+
Converts RepositoryException into an appropriate PersistException, prepending + the specified message.
+
+
toPersistException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Transforms the given throwable into an appropriate persist exception.
+
+
toPrevious() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the previous available entry, returning false if + none.
+
+
toPrevious(int) - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the previous available entry, decrementing by the + amount given.
+
+
toPreviousKey() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Move the cursor to the previous unique key, returning false if none.
+
+
toRepositoryException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Transforms the given throwable into an appropriate repository + exception.
+
+
toString() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
toString() - Method in class com.amazon.carbonado.filter.Filter.NotJoined
+
 
+
toString() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns the string value of this filter, which is also parsable.
+
+
toString() - Method in class com.amazon.carbonado.filter.FilterValues
+
+
Returns the string value of the filter with any values substituted.
+
+
toString() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
toString() - Method in enum com.amazon.carbonado.filter.RelOp
+
+
Returns one of "=", "!=", "<", ">=", ">", or "<=".
+
+
toString() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns the chained property formatted as "name.subname.subsubname".
+
+
toString() - Method in class com.amazon.carbonado.info.OrderedProperty
+
+
Returns the chained property in a parseable form.
+
+
toString() - Method in class com.amazon.carbonado.info.StorableIndex
+
 
+
toString() - Method in interface com.amazon.carbonado.info.StorableProperty
+
 
+
toString() - Method in class com.amazon.carbonado.layout.Layout
+
 
+
toString() - Method in class com.amazon.carbonado.layout.LayoutProperty
+
 
+
toString() - Method in class com.amazon.carbonado.lob.AbstractBlob
+
 
+
toString() - Method in class com.amazon.carbonado.lob.AbstractClob
+
 
+
toString() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
+
Implementation calls appendTo.
+
+
toString() - Method in class com.amazon.carbonado.qe.CompositeScore
+
 
+
toString() - Method in class com.amazon.carbonado.qe.FilteringScore
+
 
+
toString() - Method in class com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result
+
 
+
toString() - Method in class com.amazon.carbonado.qe.OrderingScore
+
 
+
toString() - Method in class com.amazon.carbonado.qe.QueryHints
+
 
+
toString() - Method in class com.amazon.carbonado.Query.Timeout
+
 
+
toString() - Method in interface com.amazon.carbonado.Query
+
+
Returns a description of the query filter and any other arguments.
+
+
toString() - Method in class com.amazon.carbonado.raw.StorablePropertyInfo
+
 
+
toString() - Method in class com.amazon.carbonado.spi.IndexInfoImpl
+
 
+
toString() - Method in interface com.amazon.carbonado.Storable
+
+
Returns a string for debugging purposes that contains all supported + property names and values for this object.
+
+
toString() - Method in class com.amazon.carbonado.synthetic.SyntheticProperty
+
 
+
toString() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
toString() - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+
toStringKeyOnly() - Method in interface com.amazon.carbonado.Storable
+
+
Returns a string for debugging purposes that contains supported key + property names and values for this object.
+
+
Transaction - Interface in com.amazon.carbonado
+
+
Transactions define atomic operations which can be committed or aborted as a + unit.
+
+
transactionManager() - Method in class com.amazon.carbonado.spi.AbstractRepository
+
+
Returns the repository's TransactionManager.
+
+
TransactionManager<Txn> - Class in com.amazon.carbonado.txn
+
+
Generic transaction manager for repositories.
+
+
TransactionManager() - Constructor for class com.amazon.carbonado.txn.TransactionManager
+
 
+
TransactionManager(TransactionMonitor) - Constructor for class com.amazon.carbonado.txn.TransactionManager
+
 
+
TransactionMonitor - Interface in com.amazon.carbonado.txn
+
+
Is notified as transactions enter and exit.
+
+
TransactionPair - Class in com.amazon.carbonado.txn
+
+
Pairs two transaction together into one.
+
+
TransactionPair(Transaction, Transaction) - Constructor for class com.amazon.carbonado.txn.TransactionPair
+
 
+
TransactionScope<Txn> - Class in com.amazon.carbonado.txn
+
+
Container of thread local, scoped transactions.
+
+
transform(S) - Method in class com.amazon.carbonado.cursor.MultiTransformedCursor
+
+
This method must be implemented to transform storables.
+
+
transform(S) - Method in class com.amazon.carbonado.cursor.TransformedCursor
+
+
This method must be implemented to transform storables.
+
+
TransformedCursor<S,T> - Class in com.amazon.carbonado.cursor
+
+
Abstract cursor which wraps another cursor and transforms each storable + result into a target storable.
+
+
TransformedCursor(Cursor<S>) - Constructor for class com.amazon.carbonado.cursor.TransformedCursor
+
 
+
transformIntoFetchException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Override to support custom transformations, returning null if none is + applicable.
+
+
transformIntoPersistException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Override to support custom transformations, returning null if none is + applicable.
+
+
transformIntoRepositoryException(Throwable) - Method in class com.amazon.carbonado.spi.ExceptionTransformer
+
+
Override to support custom transformations, returning null if none is + applicable.
+
+
Trigger<S> - Class in com.amazon.carbonado
+
+
Callback mechanism to allow custom code to run when a storable is + persisted.
+
+
Trigger() - Constructor for class com.amazon.carbonado.Trigger
+
 
+
Trigger.Abort - Exception in com.amazon.carbonado
+
 
+
TriggerFactory - Interface in com.amazon.carbonado
+
+
Can be used with RepositoryBuilder to automatically register + triggers as Storable types become available.
+
+
triggerFor(Class<S>) - Method in interface com.amazon.carbonado.TriggerFactory
+
+
Return an appropriate trigger for the given type, or null if none.
+
+
TriggerManager<S extends Storable> - Class in com.amazon.carbonado.spi
+
+
Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.
+
+
TriggerManager() - Constructor for class com.amazon.carbonado.spi.TriggerManager
+
 
+
TriggerManager(Class<S>, Iterable<TriggerFactory>) - Constructor for class com.amazon.carbonado.spi.TriggerManager
+
 
+
TriggerManagerCapability - Interface in com.amazon.carbonado.spi
+
+
Provides the capability to get the TriggerManager from a Repository.
+
+
TriggerSupport<S extends Storable> - Interface in com.amazon.carbonado.gen
+
+
Provides runtime support for Storable classes generated by StorableGenerator.
+
+
trim() - Method in class com.amazon.carbonado.info.ChainedProperty
+
+
Returns a new ChainedProperty with the last property in the chain removed.
+
+
TrueFalseAdapter - Annotation Type in com.amazon.carbonado.adapter
+
+
Adapter that converts 'T' or 'F' to and from a boolean value.
+
+
TrueFalseAdapter.Adapter - Class in com.amazon.carbonado.adapter
+
+
Adapter implementation for TrueFalseAdapter.
+
+
TrueFalseAdapter.Adapter(Class<?>, String, TrueFalseAdapter) - Constructor for class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
 
+
TrueFalseAdapter.Adapter(Class<?>, String, boolean) - Constructor for class com.amazon.carbonado.adapter.TrueFalseAdapter.Adapter
+
 
+
truncate() - Method in interface com.amazon.carbonado.Storage
+
+
Attempts to quickly delete all Storables instances in this + Storage.
+
+
TRY_DELETE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
TRY_INSERT_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
TRY_LOAD_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
TRY_LOAD_ONE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Query API method name
+
+
TRY_UPDATE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
tryDelete(S, byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Try to delete the entry referenced by the given key.
+
+
tryDelete() - Method in interface com.amazon.carbonado.Storable
+
+
Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.
+
+
tryDeleteOne() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns false.
+
+
tryDeleteOne(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns false.
+
+
tryDeleteOne() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
tryDeleteOne(Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
tryDeleteOne() - Method in interface com.amazon.carbonado.Query
+
+
Deletes zero or one matching objects.
+
+
tryDeleteOne(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Deletes zero or one matching objects.
+
+
tryInsert(S, byte[], byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Try to insert the entry referenced by the given key with the given + value.
+
+
tryInsert() - Method in interface com.amazon.carbonado.Storable
+
+
Inserts a new persistent value for this object.
+
+
tryLoad(S, byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Try to load the entry referenced by the given key, but return null + if not found.
+
+
tryLoad() - Method in interface com.amazon.carbonado.Storable
+
+
Loads or reloads this object from the storage layer by a primary or + alternate key.
+
+
tryLoadOne() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
tryLoadOne(Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
tryLoadOne() - Method in interface com.amazon.carbonado.Query
+
+
Tries to load one record, but returns null if nothing was found.
+
+
tryLoadOne(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Tries to load one record, but returns null if nothing was found.
+
+
tryUpdate() - Method in interface com.amazon.carbonado.Storable
+
+
Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.
+
+
+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