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

R

+
+
RAFInputStream - Class in com.amazon.carbonado.spi
+
+
InputStream that wraps a RandomAccessFile.
+
+
RAFInputStream(RandomAccessFile) - Constructor for class com.amazon.carbonado.spi.RAFInputStream
+
 
+
RAFOutputStream - Class in com.amazon.carbonado.spi
+
+
OutputStream that wraps a RandomAccessFile.
+
+
RAFOutputStream(RandomAccessFile) - Constructor for class com.amazon.carbonado.spi.RAFOutputStream
+
 
+
rangeComparator() - Static method in class com.amazon.carbonado.qe.FilteringScore
+
+
Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.
+
+
RawCursor<S> - Class in com.amazon.carbonado.raw
+
+
Abstract Cursor implementation for a repository that manipulates raw bytes.
+
+
RawCursor(Lock, byte[], boolean, byte[], boolean, int, boolean) - Constructor for class com.amazon.carbonado.raw.RawCursor
+
 
+
RawStorableGenerator - Class in com.amazon.carbonado.raw
+
+
Generates and caches abstract implementations of Storable types + which are encoded and decoded in a raw format.
+
+
RawSupport<S extends Storable> - Interface in com.amazon.carbonado.raw
+
+
Provides runtime support for Storable classes generated by RawStorableGenerator.
+
+
RawUtil - Class in com.amazon.carbonado.raw
+
+
Utilities for manipulating binary data.
+
+
RawUtil() - Constructor for class com.amazon.carbonado.raw.RawUtil
+
 
+
read() - Method in class com.amazon.carbonado.spi.RAFInputStream
+
 
+
read(byte[]) - Method in class com.amazon.carbonado.spi.RAFInputStream
+
 
+
read(byte[], int, int) - Method in class com.amazon.carbonado.spi.RAFInputStream
+
 
+
READ_FROM - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
readFrom(InputStream) - Method in interface com.amazon.carbonado.Storable
+
+
Restores property values and states as encoded by Storable.writeTo(java.io.OutputStream).
+
+
readFully(InputStream, byte[]) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Reads as many bytes from the stream as is necessary to fill the given + byte array.
+
+
readLayoutFrom(InputStream) - Method in class com.amazon.carbonado.layout.LayoutFactory
+
+
Read a layout as written by Layout.writeTo(java.io.OutputStream).
+
+
readLength(InputStream) - Static method in class com.amazon.carbonado.raw.DataDecoder
+
+
Decodes a length value which was encoded by DataEncoder.writeLength(int, java.io.OutputStream).
+
+
receive() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Request
+
+
Receive data from caller.
+
+
receiveInto(Collection<? super D>) - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Request
+
+
Receive all remaining data from caller.
+
+
reconstruct() - Method in class com.amazon.carbonado.layout.Layout
+
+
Reconstructs the storable type defined by this layout by returning an + auto-generated class.
+
+
reconstruct(ClassLoader) - Method in class com.amazon.carbonado.layout.Layout
+
+
Reconstructs the storable type defined by this layout by returning an + auto-generated class.
+
+
reduce() - Method in class com.amazon.carbonado.filter.Filter
+
+
Returns an equivalent filter with redundant terms eliminated.
+
+
reduce() - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Eliminates redundant ordering properties.
+
+
reduce() - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Reduces the size of the set by removing redundant indexes, and merges + others together.
+
+
reduce(Direction) - Method in class com.amazon.carbonado.qe.StorableIndexSet
+
+
Reduces the size of the set by removing redundant indexes, and merges + others together.
+
+
register(Class<S>, Cursor<S>) - Method in class com.amazon.carbonado.txn.TransactionScope
+
+
Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close.
+
+
release() - Method in class com.amazon.carbonado.raw.RawCursor
+
+
Release any internal resources, called when closed.
+
+
RelOp - Enum in com.amazon.carbonado.filter
+
+
Relational operator enumeration.
+
+
RemoteProcedure<R,D> - Interface in com.amazon.carbonado.capability
+
+
Defines a remote procedure which can be executed by RemoteProcedureCapability.
+
+
RemoteProcedure.Call<R,D> - Interface in com.amazon.carbonado.capability
+
+
Client-side call into a remote procedure.
+
+
RemoteProcedure.Reply<R> - Interface in com.amazon.carbonado.capability
+
+
Reply from remote procedure implementation.
+
+
RemoteProcedure.Request<R,D> - Interface in com.amazon.carbonado.capability
+
+
Request into a remote procedure, as seen by procedure implementation.
+
+
RemoteProcedureCapability - Interface in com.amazon.carbonado.capability
+
+
Capability which allows arbitrary code to run on a remote host and access + its repository.
+
+
remove(Object) - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
remove(Object) - Method in class com.amazon.carbonado.util.AbstractPool
+
+
Remove a value, returning the old value.
+
+
remove(K) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+
remove(K, V) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+
removeTrigger(Trigger<? super S>) - Method in class com.amazon.carbonado.spi.TriggerManager
+
 
+
removeTrigger(Trigger<? super S>) - Method in interface com.amazon.carbonado.Storage
+
+
Remove a trigger which was registered earlier.
+
+
removeTriggerFactory(TriggerFactory) - Method in interface com.amazon.carbonado.RepositoryBuilder
+
+
Remove a TriggerFactory which was added earlier.
+
+
removeTriggerFactory(TriggerFactory) - Method in class com.amazon.carbonado.spi.AbstractRepositoryBuilder
+
 
+
repair(double) - Method in interface com.amazon.carbonado.repo.indexed.IndexEntryAccessor
+
+
Repairs the index by inserting missing entries and fixing + inconsistencies.
+
+
RepairExecutor - Class in com.amazon.carbonado.spi
+
+
A convenience class for repositories to run dynamic repairs in separate + threads.
+
+
replace(int, OrderedProperty<S>) - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns a list with the given element replaced.
+
+
replace(K, V, V) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+
replace(K, V) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+
ReplicatedRepositoryBuilder - Class in com.amazon.carbonado.repo.replicated
+
+
Repository builder for the replicated repository.
+
+
ReplicatedRepositoryBuilder() - Constructor for class com.amazon.carbonado.repo.replicated.ReplicatedRepositoryBuilder
+
 
+
Repository - Interface in com.amazon.carbonado
+
+
A Repository represents a database for Storable + instances.
+
+
RepositoryAccess - Interface in com.amazon.carbonado.qe
+
+
Provides internal access to a Repository, necessary for query + execution.
+
+
RepositoryBuilder - Interface in com.amazon.carbonado
+
+
Standard interface for building up configuration and opening a Repository instance.
+
+
RepositoryException - Exception in com.amazon.carbonado
+
+
General checked exception thrown when accessing a Repository.
+
+
RepositoryException() - Constructor for exception com.amazon.carbonado.RepositoryException
+
 
+
RepositoryException(String) - Constructor for exception com.amazon.carbonado.RepositoryException
+
 
+
RepositoryException(String, Throwable) - Constructor for exception com.amazon.carbonado.RepositoryException
+
 
+
RepositoryException(Throwable) - Constructor for exception com.amazon.carbonado.RepositoryException
+
 
+
reset() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Call
+
+
Reset the internal object stream of the call, allowing cached + objects to get freed.
+
+
reset() - Method in interface com.amazon.carbonado.capability.RemoteProcedure.Reply
+
+
Reset the internal object stream of the reply, allowing cached + objects to get freed.
+
+
reset(int) - Method in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Reset the sequence.
+
+
resetExecutor() - Method in class com.amazon.carbonado.qe.StandardQuery
+
+
Resets any cached reference to a query executor.
+
+
resetExecutors() - Method in class com.amazon.carbonado.qe.StandardQueryFactory
+
+
For each cached query, calls StandardQuery.resetExecutor().
+
+
resumeCheckpointer() - Method in interface com.amazon.carbonado.repo.sleepycat.CheckpointCapability
+
+
Resumes the checkpointer if it was suspended.
+
+
resync(Class<S>, double, String, Object...) - Method in interface com.amazon.carbonado.capability.ResyncCapability
+
+
Re-synchronizes replicated storables against the master repository.
+
+
resync(Class<S>, ResyncCapability.Listener<? super S>, double, String, Object...) - Method in interface com.amazon.carbonado.capability.ResyncCapability
+
+
Re-synchronizes replicated storables against the master repository.
+
+
ResyncCapability - Interface in com.amazon.carbonado.capability
+
+
Capability of replicating repositories for re-synchronizing to the master + repository.
+
+
ResyncCapability.Listener<S> - Class in com.amazon.carbonado.capability
+
+
Trigger which is invoked as storables get re-sync'd.
+
+
ResyncCapability.Listener() - Constructor for class com.amazon.carbonado.capability.ResyncCapability.Listener
+
 
+
returnReservedValues() - Method in class com.amazon.carbonado.sequence.SequenceValueGenerator
+
+
Allow any unused reserved values to be returned for re-use.
+
+
returnReservedValues() - Method in interface com.amazon.carbonado.sequence.SequenceValueProducer
+
+
Allow any unused reserved values to be returned for re-use.
+
+
returnReservedValues(Log) - Method in class com.amazon.carbonado.sequence.SequenceValueProducerPool
+
+
Returns reserved values for all SequenceValueProducers.
+
+
reuseTxn(Txn) - Method in class com.amazon.carbonado.txn.TransactionManager
+
+
Called when a transaction is about to be reused.
+
+
reverse() - Method in enum com.amazon.carbonado.filter.RelOp
+
 
+
reverse() - Method in enum com.amazon.carbonado.info.Direction
+
+
Returns the reverse direction of this.
+
+
reverse() - Method in class com.amazon.carbonado.info.OrderedProperty
+
 
+
reverse() - Method in class com.amazon.carbonado.info.StorableIndex
+
+
Returns a StorableIndex instance with all the properties reversed.
+
+
reverseDirections() - Method in class com.amazon.carbonado.qe.OrderingList
+
+
Returns this list with all orderings in reverse.
+
+
run() - Method in class com.amazon.carbonado.layout.LayoutSync
+
 
+
run() - Method in class com.amazon.carbonado.util.TaskQueueThread
+
 
+
+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