com.amazon.carbonado (Carbonado 1.2.3 API)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Interface Summary
Interface	Description
Cursor<S>	+ Represents the results of a `Query`'s fetch + operation. +
Query<S extends Storable>	+ Supports complex retrieval and deletion of `Storable` objects. +
Query.Controller	+ Controller instance can be used to abort query operations. +
Repository	+ A Repository represents a database for `Storable` + instances. +
RepositoryBuilder	+ Standard interface for building up configuration and opening a `Repository` instance. +
Storable<S extends Storable<S>>	+ A data access object in a `Repository`. +
Storage<S extends Storable>	+ Access for a specific type of `Storable` from a `Repository`. +
Transaction	+ Transactions define atomic operations which can be committed or aborted as a + unit. +
TriggerFactory	+ Can be used with `RepositoryBuilder` to automatically register + triggers as Storable types become available. +

+ + + + + + + + + + + + + + + + +
Class Summary
Class Description
Query.Timeout +
Timeout controller, for aborting long running queries.
+
Trigger<S> +
Callback mechanism to allow custom code to run when a storable is + persisted.
+
+
+ + + + + + + + + + + + +
Enum Summary
Enum Description
IsolationLevel +
Describes a transaction isolation level.
+
+

Class Summary
Class	Description
Query.Timeout	+ Timeout controller, for aborting long running queries. +
Trigger<S>	+ Callback mechanism to allow custom code to run when a storable is + persisted. +

Enum Summary
Enum	Description
IsolationLevel	+ Describes a transaction isolation level. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Exception Summary
Exception	Description
ConfigurationException	+ Indicates that a `Repository` could not be + instantiated given the configuration information provided to a `RepositoryBuilder`. +
ConstraintException	+ A ConstraintException is thrown if the `Repository` storage layer + detects any kind of constraint violation. +
CorruptEncodingException	+ A CorruptEncodingException is caused when decoding an encoded record fails. +
FetchDeadlockException	+ Thrown if a fetch operation fails because it was selected to resolve a + deadlock. +
FetchException	+ A FetchException is caused by a failure when selecting records from a `Repository`. +
FetchInterruptedException	+ Thrown from a fetch operation that was canceled. +
FetchMultipleException	+ A FetchMultipleException is thrown when a fetch operation returned more + than one record when at most one was expected. +
FetchNoneException	+ A FetchNoneException is thrown when a fetch operation returned no records + when at least one was expected. +
FetchTimeoutException	+ Thrown if a fetch operation fails because lock acquisition timed out. +
MalformedArgumentException	+ A MalformedArgumentException is thrown after detailed analysis on an + argument determined it was not suitable. +
MalformedFilterException	+ A MalformedFilterException indicates that a + `query filter` is invalid. +
MalformedTypeException	+ A MalformedTypeException indicates that a `Storable` is defined in a + way that violates the requirements for Storable objects. +
MismatchException	+ Indicates that a `Storable` doesn't exactly match up with an external + schema. +
NonDurableCommitException	+ Thrown during a transaction commit if durability guarantees cannot be met. +
OptimisticLockException	+ An OptimisticLockException is thrown if the `Repository` is using + optimistic locking for concurrency control, and lock aquisition failed. +
PersistDeadlockException	+ Thrown if a persist operation fails because it was selected to resolve a + deadlock. +
PersistDeniedException	+ Thrown when a persist operation was denied either because the repository is + in read-only mode, or the connection does not have permission. +
PersistException	+ A PersistException is caused by a failure when inserting, updating, or + deleting records from a `Repository`. +
PersistInterruptedException	+ Thrown from a persist operation that was canceled. +
PersistMultipleException	+ A PersistMultipleException is thrown when a persist operation would have + applied to more than one record when at most one was expected. +
PersistNoneException	+ A PersistNoneException is thrown when a persist operation applied to no + records when at least one was expected. +
PersistTimeoutException	+ Thrown if a persist operation fails because lock acquisition timed out. +
RepositoryException	+ General checked exception thrown when accessing a `Repository`. +
SupportException	+ Indicates that an action cannot be supported by the `Repository` it is being requested from. +
Trigger.Abort
UniqueConstraintException	+ A UniqueConstraintException is thrown if the `Repository` storage + layer has a unique constraint check defined for a property, and a violation + has been detected. +
UnsupportedTypeException	+ Thrown by a `Repository` which cannot support a `Storable` which + is declared as `Independent` or `Authoritative`. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Annotation Types Summary
Annotation Type	Description
Alias	+ Identifies alternate names for a `Storable` or a Storable property. +
AlternateKeys	+ List of alternate keys for a `Storable`. +
Authoritative	+ Indicates that all accesses to this `Storable` must come from an + authoritative source. +
Automatic	+ Identifies a `Storable` property capable of selecting its own value on + insert. +
Derived	+ Identifies a `Storable` property which is not directly persisted, but + is instead derived from other property values. +
Independent	+ A hint for a dependent `Repository` to allow a `Storable` property or type + to be undefined in the underlying schema. +
Index	+ An Index annotation provides a hint to the storage layer allowing `queries` to be performed more quickly. +
Indexes	+ The Indexes annotation is applied to a `Storable` for specifying all + the `indexes` it should have. +
Join	+ Identifies a `Storable` property as defining a join relationship + with another Storable type. +
Key	+ Identifies a `Storable` property as being a member of an alternate + key. +
Name	+ Overrides the primary name of a Storable property. +
Nullable	+ Identifies that a `Storable` property can have a null value. +
PartitionKey	+ Identifies a `Storable` property as being a member of the partition key. +
PrimaryKey	+ Identifies a `Storable` property as being a member of the primary + key. +
Sequence	+ Identifies a `Storable` property capable of selecting its own value on + insert, by a named sequence. +
Version	+ Designates a `Storable` property as being the authoritative version + number for the entire Storable instance. +

+ + + +

Package com.amazon.carbonado Description

Main user-level interfaces, classes, and annotations for Carbonado.