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/overview-summary.html | 319 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 319 insertions(+) create mode 100644 apidocs/overview-summary.html (limited to 'apidocs/overview-summary.html') diff --git a/apidocs/overview-summary.html b/apidocs/overview-summary.html new file mode 100644 index 0000000..bb56939 --- /dev/null +++ b/apidocs/overview-summary.html @@ -0,0 +1,319 @@ + + + + + + +Overview (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Carbonado 1.2.3 API

+
+
+ + + + + + + + + + + + + + + + + + + + +
Basic API 
PackageDescription
com.amazon.carbonado +
Main user-level interfaces, classes, and annotations for Carbonado.
+
com.amazon.carbonado.adapter +
Contains annotations and implementations for supporting property adapters.
+
com.amazon.carbonado.constraint +
Contains annotations and implementations for supporting property constraints.
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Advanced API 
PackageDescription
com.amazon.carbonado.capability +
Common capabilities for repositories.
+
com.amazon.carbonado.cursor +
Support for advanced processing of cursor results, including basic set + theory operations.
+
com.amazon.carbonado.filter +
Contains classes for representing query filters.
+
com.amazon.carbonado.info +
Introspection support for Storables.
+
com.amazon.carbonado.layout +
Support for recording the evolution of a storable's layout, used internally + by some repositories.
+
com.amazon.carbonado.lob +
Support for LOB property types, which are Large OBjects.
+
com.amazon.carbonado.sequence +
Support for generating sequences of values, intended for creating surrogate + keys.
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Standard Repositories 
PackageDescription
com.amazon.carbonado.repo.jdbc +
Repository implementation that connects to an external SQL database via + JDBC.
+
com.amazon.carbonado.repo.logging +
Repository implementation which logs activity against it.
+
com.amazon.carbonado.repo.map +
Volatile repository implementation backed by a concurrent map.
+
com.amazon.carbonado.repo.replicated +
Repository implementation that supports replication between two + repositories.
+
com.amazon.carbonado.repo.sleepycat +
Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Service Provider Interface 
PackageDescription
com.amazon.carbonado.gen +
Storable code generation support intended for use by repository implementations.
+
com.amazon.carbonado.qe +
Support for implementing a Query Engine.
+
com.amazon.carbonado.raw +
Provides support for repositories that encode/decode storables in a raw + binary format.
+
com.amazon.carbonado.repo.indexed +
Repository implementation that adds index support for repositories that have + little or no index support.
+
com.amazon.carbonado.spi +
Service Provider Interface for Carbonado.
+
com.amazon.carbonado.synthetic +
Support for dynamic creation of storables, intended for internal use by + repository implementations.
+
com.amazon.carbonado.txn +
Provides support for managing transactions.
+
+
+
+ + + + + + + + + + + + +
Generic Utilities 
PackageDescription
com.amazon.carbonado.util +
Utilities used by Carbonado but which have no dependencies on + Carbonado.
+
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3