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

P

+
+
parse(StorableInfo<S>, String) - Static method in class com.amazon.carbonado.info.ChainedProperty
+
+
Parses a chained property.
+
+
parse(StorableInfo<S>, String) - Static method in class com.amazon.carbonado.info.OrderedProperty
+
+
Parses an ordering property, which may start with a '+' or '-' to + indicate direction.
+
+
parse(StorableInfo<S>, String, Direction) - Static method in class com.amazon.carbonado.info.OrderedProperty
+
+
Parses an ordering property, which may start with a '+' or '-' to + indicate direction.
+
+
parse(Annotation) - Method in class com.amazon.carbonado.util.AnnotationDescParser
+
+
Parses the given annotation, returning the root annotation that received + the results.
+
+
parseNameDescriptor(String, StorableInfo<S>) - Static method in class com.amazon.carbonado.info.StorableIndex
+
+
Parses an index descriptor and returns an index object.
+
+
PartitionKey - Annotation Type in com.amazon.carbonado
+
+
Identifies a Storable property as being a member of the partition key.
+
+
PersistDeadlockException - Exception in com.amazon.carbonado
+
+
Thrown if a persist operation fails because it was selected to resolve a + deadlock.
+
+
PersistDeadlockException() - Constructor for exception com.amazon.carbonado.PersistDeadlockException
+
 
+
PersistDeadlockException(String) - Constructor for exception com.amazon.carbonado.PersistDeadlockException
+
 
+
PersistDeadlockException(String, Throwable) - Constructor for exception com.amazon.carbonado.PersistDeadlockException
+
 
+
PersistDeadlockException(Throwable) - Constructor for exception com.amazon.carbonado.PersistDeadlockException
+
 
+
PersistDeniedException - Exception in com.amazon.carbonado
+
+
Thrown when a persist operation was denied either because the repository is + in read-only mode, or the connection does not have permission.
+
+
PersistDeniedException() - Constructor for exception com.amazon.carbonado.PersistDeniedException
+
 
+
PersistDeniedException(String) - Constructor for exception com.amazon.carbonado.PersistDeniedException
+
 
+
PersistDeniedException(String, Throwable) - Constructor for exception com.amazon.carbonado.PersistDeniedException
+
 
+
PersistDeniedException(Throwable) - Constructor for exception com.amazon.carbonado.PersistDeniedException
+
 
+
PersistException - Exception in com.amazon.carbonado
+
+
A PersistException is caused by a failure when inserting, updating, or + deleting records from a Repository.
+
+
PersistException() - Constructor for exception com.amazon.carbonado.PersistException
+
 
+
PersistException(String) - Constructor for exception com.amazon.carbonado.PersistException
+
 
+
PersistException(String, Throwable) - Constructor for exception com.amazon.carbonado.PersistException
+
 
+
PersistException(Throwable) - Constructor for exception com.amazon.carbonado.PersistException
+
 
+
PersistInterruptedException - Exception in com.amazon.carbonado
+
+
Thrown from a persist operation that was canceled.
+
+
PersistInterruptedException() - Constructor for exception com.amazon.carbonado.PersistInterruptedException
+
 
+
PersistInterruptedException(String) - Constructor for exception com.amazon.carbonado.PersistInterruptedException
+
 
+
PersistInterruptedException(String, Throwable) - Constructor for exception com.amazon.carbonado.PersistInterruptedException
+
 
+
PersistInterruptedException(Throwable) - Constructor for exception com.amazon.carbonado.PersistInterruptedException
+
 
+
PersistMultipleException - Exception in com.amazon.carbonado
+
+
A PersistMultipleException is thrown when a persist operation would have + applied to more than one record when at most one was expected.
+
+
PersistMultipleException() - Constructor for exception com.amazon.carbonado.PersistMultipleException
+
 
+
PersistMultipleException(String) - Constructor for exception com.amazon.carbonado.PersistMultipleException
+
 
+
PersistMultipleException(String, Throwable) - Constructor for exception com.amazon.carbonado.PersistMultipleException
+
 
+
PersistMultipleException(Throwable) - Constructor for exception com.amazon.carbonado.PersistMultipleException
+
 
+
PersistNoneException - Exception in com.amazon.carbonado
+
+
A PersistNoneException is thrown when a persist operation applied to no + records when at least one was expected.
+
+
PersistNoneException() - Constructor for exception com.amazon.carbonado.PersistNoneException
+
 
+
PersistNoneException(String) - Constructor for exception com.amazon.carbonado.PersistNoneException
+
 
+
PersistNoneException(String, Throwable) - Constructor for exception com.amazon.carbonado.PersistNoneException
+
 
+
PersistNoneException(Throwable) - Constructor for exception com.amazon.carbonado.PersistNoneException
+
 
+
PersistTimeoutException - Exception in com.amazon.carbonado
+
+
Thrown if a persist operation fails because lock acquisition timed out.
+
+
PersistTimeoutException() - Constructor for exception com.amazon.carbonado.PersistTimeoutException
+
 
+
PersistTimeoutException(String) - Constructor for exception com.amazon.carbonado.PersistTimeoutException
+
 
+
PersistTimeoutException(String, Throwable) - Constructor for exception com.amazon.carbonado.PersistTimeoutException
+
 
+
PersistTimeoutException(Throwable) - Constructor for exception com.amazon.carbonado.PersistTimeoutException
+
 
+
preCommit() - Method in interface com.amazon.carbonado.Transaction
+
+
Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads.
+
+
preCommit() - Method in class com.amazon.carbonado.txn.TransactionPair
+
 
+
prepare(Comparator<S>) - Method in class com.amazon.carbonado.cursor.ArraySortBuffer
+
 
+
prepare(Comparator<S>) - Method in class com.amazon.carbonado.cursor.MergeSortBuffer
+
 
+
prepare(Comparator<S>) - Method in interface com.amazon.carbonado.cursor.SortBuffer
+
+
Clears buffer and assigns a comparator for sorting.
+
+
prepare() - Method in interface com.amazon.carbonado.Storable
+
+
Prepares a new object for loading, inserting, updating, or deleting.
+
+
prepare() - Method in interface com.amazon.carbonado.Storage
+
+
Prepares a new object for loading, inserting, updating, or deleting.
+
+
prepare() - Method in interface com.amazon.carbonado.synthetic.SyntheticBuilder
+
 
+
prepare() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableBuilder
+
 
+
prepare() - Method in class com.amazon.carbonado.synthetic.SyntheticStorableReferenceBuilder
+
 
+
PREPARE_METHOD_NAME - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storage API method name
+
+
prepareForOpening(Object) - Method in interface com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook
+
+
Called right before database is opened.
+
+
previousGeneration() - Method in class com.amazon.carbonado.layout.Layout
+
+
Returns the previous known generation of the storable's layout, or null + if none.
+
+
PrimaryKey - Annotation Type in com.amazon.carbonado
+
+
Identifies a Storable property as being a member of the primary + key.
+
+
PrimitiveArrayAdapter - Annotation Type in com.amazon.carbonado.adapter
+
+
Allows arrays of primitive types to be encoded (big-endian) as byte arrays.
+
+
PrimitiveArrayAdapter.Adapter - Class in com.amazon.carbonado.adapter
+
+
Adapter implementation for PrimitiveArrayAdapter.
+
+
PrimitiveArrayAdapter.Adapter(Class<?>, String, PrimitiveArrayAdapter) - Constructor for class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
PrimitiveArrayAdapter.Adapter() - Constructor for class com.amazon.carbonado.adapter.PrimitiveArrayAdapter.Adapter
+
 
+
printNative() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
printNative(Appendable) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
printNative(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.AbstractQueryExecutor
+
+
Does nothing and returns false.
+
+
printNative(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
printNative(Appendable, int) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns false.
+
+
printNative(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.FilteredQueryExecutor
+
+
Prints native query of the wrapped executor.
+
+
printNative(Appendable, int, FilterValues<S>) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Prints the native query to any appendable, if applicable.
+
+
printNative(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
+
Prints native query of the wrapped executor.
+
+
printNative(Appendable, int) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
printNative(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.UnionQueryExecutor
+
+
Prints native queries of the wrapped executors.
+
+
printNative() - Method in interface com.amazon.carbonado.Query
+
+
Print the native query to standard out, which is useful for performance + analysis.
+
+
printNative(Appendable) - Method in interface com.amazon.carbonado.Query
+
+
Prints the native query to any appendable, which is useful for + performance analysis.
+
+
printNative(Appendable, int) - Method in interface com.amazon.carbonado.Query
+
+
Prints the native query to any appendable, which is useful for + performance analysis.
+
+
printPlan() - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
printPlan(Appendable) - Method in class com.amazon.carbonado.qe.AbstractQuery
+
 
+
printPlan(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.DelegatedQueryExecutor
+
 
+
printPlan(Appendable, int) - Method in class com.amazon.carbonado.qe.EmptyQuery
+
+
Always returns false.
+
+
printPlan(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.FilteredQueryExecutor
+
 
+
printPlan(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.FullScanQueryExecutor
+
 
+
printPlan(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.IndexedQueryExecutor
+
 
+
printPlan(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.IterableQueryExecutor
+
 
+
printPlan(Appendable, int, FilterValues<T>) - Method in class com.amazon.carbonado.qe.JoinedQueryExecutor
+
 
+
printPlan(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.KeyQueryExecutor
+
 
+
printPlan(Appendable, int, FilterValues<S>) - Method in interface com.amazon.carbonado.qe.QueryExecutor
+
+
Prints the query plan to any appendable, if applicable.
+
+
printPlan(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.SortedQueryExecutor
+
 
+
printPlan(Appendable, int) - Method in class com.amazon.carbonado.qe.StandardQuery
+
 
+
printPlan(Appendable, int, FilterValues<S>) - Method in class com.amazon.carbonado.qe.UnionQueryExecutor
+
 
+
printPlan() - Method in interface com.amazon.carbonado.Query
+
+
Prints the query excecution plan to standard out, which is useful for + performance analysis.
+
+
printPlan(Appendable) - Method in interface com.amazon.carbonado.Query
+
+
Prints the query excecution plan to any appendable, which is useful for + performance analysis.
+
+
printPlan(Appendable, int) - Method in interface com.amazon.carbonado.Query
+
+
Prints the query excecution plan to any appendable, which is useful for + performance analysis.
+
+
PROPERTY_MAP - Static variable in class com.amazon.carbonado.gen.CommonMethodNames
+
+
Storable API method name
+
+
PROPERTY_STATE_CLEAN - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Property state indicating that property value reflects a clean value
+
+
PROPERTY_STATE_DIRTY - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Property state indicating that property has been set, but not saved
+
+
PROPERTY_STATE_FIELD_NAME - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Prefix of protected field in generated storable that holds property + states.
+
+
PROPERTY_STATE_MASK - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Property state mask is 3, to cover the two bits used by a property state
+
+
PROPERTY_STATE_UNINITIALIZED - Static variable in class com.amazon.carbonado.gen.StorableGenerator
+
+
Property state indicating that property has never been set, loaded, or saved
+
+
PropertyFilter<S extends Storable> - Class in com.amazon.carbonado.filter
+
+
Filter tree node that performs a relational test against a specific property + value.
+
+
propertyMap() - Method in interface com.amazon.carbonado.Storable
+
+
Returns a fixed-size map view of this Storable's properties.
+
+
pushDecodingInstanceVar(CodeAssembler, int, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Push decoding instanceVar to stack in preparation to calling + storePropertyValue.
+
+
pushRawSupport(CodeAssembler, LocalVariable) - Method in class com.amazon.carbonado.raw.GenericEncodingStrategy
+
+
Generates code to push RawSupport instance to the stack.
+
+
put(String, Object) - Method in class com.amazon.carbonado.gen.StorablePropertyMap
+
 
+
put(K, V) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+
putIfAbsent(K, V) - Method in class com.amazon.carbonado.util.SoftValuedCache
+
+
Deprecated.
+
+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