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

D

+
+
databaseName(String) - Method in interface com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook
+
+
Returns an appropriate database name for the given type.
+
+
DataDecoder - Class in com.amazon.carbonado.raw
+
+
A very low-level class that decodes key components encoded by methods of + DataEncoder.
+
+
DataDecoder() - Constructor for class com.amazon.carbonado.raw.DataDecoder
+
 
+
DataEncoder - Class in com.amazon.carbonado.raw
+
+
A very low-level class that supports encoding of primitive data.
+
+
DataEncoder() - Constructor for class com.amazon.carbonado.raw.DataEncoder
+
 
+
DateTimeAdapter - Annotation Type in com.amazon.carbonado.adapter
+
+
Converts Joda-Time datetime objects to and from other forms.
+
+
DateTimeAdapter.Adapter - Class in com.amazon.carbonado.adapter
+
+
Adapter implementation for DateTimeAdapter.
+
+
DateTimeAdapter.Adapter(Class<?>, String, DateTimeAdapter) - Constructor for class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
DateTimeAdapter.Adapter(Class<?>, String, DateTimeZone) - Constructor for class com.amazon.carbonado.adapter.DateTimeAdapter.Adapter
+
 
+
decode(byte[]) - Method in class com.amazon.carbonado.layout.LayoutOptions
+
 
+
decode(byte[], int, BigInteger[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a BigInteger.
+
+
decode(byte[], int, BigDecimal[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a BigDecimal.
+
+
decode(byte[], int, byte[][]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes the given byte array.
+
+
decode(S, int, byte[]) - Method in class com.amazon.carbonado.raw.GenericStorableCodec
+
 
+
decode(S, byte[]) - Method in interface com.amazon.carbonado.raw.GenericStorableCodec.Decoder
+
 
+
decode(byte[], int, BigInteger[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given BigInteger as originally encoded for ascending order.
+
+
decode(byte[], int, BigDecimal[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given BigDecimal as originally encoded for ascending order.
+
+
decode(byte[], int, byte[][]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array as originally encoded for ascending order.
+
+
decode(S, int, byte[]) - Method in interface com.amazon.carbonado.raw.RawSupport
+
+
Used for decoding different generations of Storable.
+
+
decode(S, int, byte[]) - Method in interface com.amazon.carbonado.raw.StorableCodec
+
+
Used for decoding different generations of Storable.
+
+
DECODE_DATA_METHOD_NAME - Static variable in class com.amazon.carbonado.raw.RawStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DECODE_KEY_METHOD_NAME - Static variable in class com.amazon.carbonado.raw.RawStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
decodeBoolean(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a boolean from exactly 1 byte.
+
+
decodeBooleanDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a boolean from exactly 1 byte, as encoded for descending order.
+
+
decodeBooleanObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a Boolean object from exactly 1 byte.
+
+
decodeBooleanObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.
+
+
decodeByte(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed byte from exactly 1 byte.
+
+
decodeByteDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed byte from exactly 1 byte, as encoded for descending + order.
+
+
decodeByteObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed Byte object from exactly 1 or 2 bytes.
+
+
decodeByteObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order.
+
+
decodeChar(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a char from exactly 2 bytes.
+
+
decodeCharacterObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a Character object from exactly 1 or 3 bytes.
+
+
decodeCharacterObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order.
+
+
decodeCharDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a char from exactly 2 bytes, as encoded for descending order.
+
+
decodeData(S, byte[]) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
+
Decode the data into properties of the storable.
+
+
decodeDesc(byte[], int, BigInteger[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given BigInteger as originally encoded for descending order.
+
+
decodeDesc(byte[], int, BigDecimal[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given BigDecimal as originally encoded for descending order.
+
+
decodeDesc(byte[], int, byte[][]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array as originally encoded for descending order.
+
+
decodeDouble(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a double from exactly 8 bytes.
+
+
decodeDoubleBits(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
 
+
decodeDoubleDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a double from exactly 8 bytes, as encoded for descending order.
+
+
decodeDoubleObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a Double object from exactly 8 bytes.
+
+
decodeDoubleObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a Double object from exactly 8 bytes.
+
+
decodeFloat(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a float from exactly 4 bytes.
+
+
decodeFloatBits(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
 
+
decodeFloatDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a float from exactly 4 bytes, as encoded for descending order.
+
+
decodeFloatObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a Float object from exactly 4 bytes.
+
+
decodeFloatObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a Float object from exactly 4 bytes.
+
+
decodeInt(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed integer from exactly 4 bytes.
+
+
decodeIntDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.
+
+
decodeIntegerObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed Integer object from exactly 1 or 5 bytes.
+
+
decodeIntegerObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order.
+
+
decodeLong(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed long from exactly 8 bytes.
+
+
decodeLongDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed long from exactly 8 bytes, as encoded for descending + order.
+
+
decodeLongObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed Long object from exactly 1 or 9 bytes.
+
+
decodeLongObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order.
+
+
decodePrimaryKey(S, byte[]) - Method in class com.amazon.carbonado.raw.CustomStorableCodec
+
+
Decode the primary key into properties of the storable.
+
+
decodeShort(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed short from exactly 2 bytes.
+
+
decodeShortDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed short from exactly 2 bytes, as encoded for descending + order.
+
+
decodeShortObj(byte[], int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a signed Short object from exactly 1 or 3 bytes.
+
+
decodeShortObjDesc(byte[], int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order.
+
+
decodeSingle(byte[], int, int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes the given byte array which was encoded by DataEncoder.encodeSingle(byte[], int, int).
+
+
decodeSingleDesc(byte[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]).
+
+
decodeSingleDesc(byte[], int, int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array which was encoded by KeyEncoder.encodeSingleDesc(byte[]).
+
+
decodeSingleNullable(byte[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]).
+
+
decodeSingleNullable(byte[], int, int) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes the given byte array which was encoded by DataEncoder.encodeSingleNullable(byte[]).
+
+
decodeSingleNullableDesc(byte[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]).
+
+
decodeSingleNullableDesc(byte[], int, int) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes the given byte array which was encoded by KeyEncoder.encodeSingleNullableDesc(byte[]).
+
+
decodeString(byte[], int, String[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes an encoded string from the given byte array.
+
+
decodeString(byte[], int, String[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes an encoded string from the given byte array.
+
+
decodeStringDesc(byte[], int, String[]) - Static method in class com.amazon.carbonado.raw.KeyDecoder
+
+
Decodes an encoded string from the given byte array as originally + encoded for descending order.
+
+
decompress(byte[], int) - Static method in class com.amazon.carbonado.raw.GzipCompressor
+
+
Decodes from compressed form.
+
+
decrement(byte[]) - Static method in class com.amazon.carbonado.raw.RawUtil
+
+
Subtracts one from an unsigned integer, represented as a byte array.
+
+
DEFAULT_INCREMENT - Static variable in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
 
+
DEFAULT_INITIAL_VALUE - Static variable in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
 
+
DEFAULT_RESERVE_AMOUNT - Static variable in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
 
+
defineCopyBridges(ClassFile, Class) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
+
+
definePrepareBridges(ClassFile, Class) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).
+
+
definePrepareMethod(ClassFile, Class, TypeDesc) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
+
+
definePrepareMethod(ClassFile, Class, TypeDesc, String, TypeDesc) - Static method in class com.amazon.carbonado.gen.CodeBuilderUtil
+
+
Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.
+
+
definePropertyBeanMethods(ClassFile, SyntheticProperty) - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
+
Add the get & set methods for this property
+
+
DelegatedQueryExecutor<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutor which delegates by executing a Query on a Storage.
+
+
DelegatedQueryExecutor(Storage<S>, QueryExecutor<S>) - Constructor for class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
DelegatedQueryExecutor(Storage<S>, Filter<S>, OrderingList<S>) - Constructor for class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
DelegatedQueryExecutorFactory<S extends Storable> - Class in com.amazon.carbonado.qe
+
+
QueryExecutorFactory which produces executors which delegate via DelegatedQueryExecutor.
+
+
DelegatedQueryExecutorFactory(Storage<S>) - Constructor for class com.amazon.carbonado.qe.DelegatedQueryExecutorFactory
+
 
+
DelegateStorableGenerator<S extends Storable> - Class in com.amazon.carbonado.gen
+
+
Generates and caches concrete implementations of Storable types + which delegate to DelegateSupport.
+
+
DelegateSupport<S extends Storable> - Interface in com.amazon.carbonado.gen
+
+
Provides runtime support for Storable classes generated by DelegateStorableGenerator.
+
+
delete() - 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.
+
+
DELETE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
deleteAll() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Does nothing.
+
+
deleteAll(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Does nothing.
+
+
deleteAll() - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
deleteAll(Query.Controller) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
deleteAll() - Method in interface com.amazon.carbonado.Query
+
+
Deletes zero or more matching objects.
+
+
deleteAll(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Deletes zero or more matching objects.
+
+
deleteLob(long) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Deletes Lob data, freeing up all space consumed by it.
+
+
deleteLob(Lob) - Method in class com.amazon.carbonado.spi.LobEngine
+
+
Deletes Lob data, freeing up all space consumed by it.
+
+
deleteOne() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
deleteOne(Query.Controller) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
deleteOne() - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws PersistNoneException.
+
+
deleteOne(Query.Controller) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always throws PersistNoneException.
+
+
deleteOne() - Method in interface com.amazon.carbonado.Query
+
+
Deletes one matching object.
+
+
deleteOne(Query.Controller) - Method in interface com.amazon.carbonado.Query
+
+
Deletes one matching object.
+
+
Derived - Annotation Type in com.amazon.carbonado
+
+
Identifies a Storable property which is not directly persisted, but + is instead derived from other property values.
+
+
detach() - Method in interface com.amazon.carbonado.Transaction
+
+
Detaches this transaction from the current thread.
+
+
detach() - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
DetachedStorableFactory<S extends Storable> - Class in com.amazon.carbonado.gen
+
+
Creates Storable instances which are basic data containers.
+
+
DetachedStorableFactory(Class<S>) - Constructor for class com.amazon.carbonado.gen.DetachedStorableFactory
+
 
+
detachLocalScope() - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Detaches the thread-local TransactionScope from the current thread.
+
+
detachNotification(Txn) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Called to notify internal method that transaction is detached.
+
+
DifferenceCursor<S> - Class in com.amazon.carbonado.cursor
+
+
Wraps two Cursors and performs an asymmetric set difference + operation.
+
+
DifferenceCursor(Cursor<S>, Cursor<S>, Comparator<S>) - Constructor for class com.amazon.carbonado.cursor.DifferenceCursor
+
 
+
Direction - Enum in com.amazon.carbonado.info
+
+
Describes a property sorting direction.
+
+
direction(Direction) - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
disableKeyAndValue() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
An optimization hint which disables key and value acquisition.
+
+
disableValue() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
An optimization hint which disables just value acquisition.
+
+
disjunctiveNormalForm() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns an equivalent filter that is in disjunctive normal form.
+
+
disjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.ClosedFilter
+
 
+
disjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.Filter
+
+
Splits the filter from its disjunctive normal form.
+
+
disjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.OpenFilter
+
 
+
disjunctiveNormalFormSplit() - Method in class com.amazon.carbonado.filter.PropertyFilter
+
 
+
DO_TRY_DELETE_MASTER_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_DELETE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_INSERT_MASTER_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_INSERT_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_LOAD_MASTER_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_LOAD_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_UPDATE_MASTER_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.MasterStorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
DO_TRY_UPDATE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Name of protected abstract method in generated storable
+
+
doFire(Throwable) - Method in class com.amazon.carbonado.util.ThrowUnchecked
+
+
Deprecated.
+
doTryDelete(S) - Method in interface com.amazon.carbonado.gen.DelegateSupport
+
 
+
doTryInsert(S) - Method in interface com.amazon.carbonado.gen.DelegateSupport
+
 
+
doTryLoad(S) - Method in interface com.amazon.carbonado.gen.DelegateSupport
+
 
+
doTryUpdate(S) - Method in interface com.amazon.carbonado.gen.DelegateSupport
+
 
+
+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