Uses of Class com.amazon.carbonado.layout.Layout (Carbonado 1.2.3 API)

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 --- .../amazon/carbonado/layout/class-use/Layout.html | 317 +++++++++++++++++++++ .../layout/class-use/LayoutCapability.html | 162 +++++++++++ .../carbonado/layout/class-use/LayoutFactory.html | 117 ++++++++ .../carbonado/layout/class-use/LayoutOptions.html | 246 ++++++++++++++++ .../carbonado/layout/class-use/LayoutProperty.html | 169 +++++++++++ .../carbonado/layout/class-use/LayoutSync.html | 117 ++++++++ .../carbonado/layout/class-use/StoredLayout.html | 117 ++++++++ .../layout/class-use/StoredLayoutEquivalence.html | 117 ++++++++ .../layout/class-use/StoredLayoutProperty.html | 117 ++++++++ .../carbonado/layout/class-use/Unevolvable.html | 230 +++++++++++++++ 10 files changed, 1709 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/Layout.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html create mode 100644 apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html (limited to 'apidocs/com/amazon/carbonado/layout/class-use') diff --git a/apidocs/com/amazon/carbonado/layout/class-use/Layout.html b/apidocs/com/amazon/carbonado/layout/class-use/Layout.html new file mode 100644 index 0000000..0e91eec --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/Layout.html @@ -0,0 +1,317 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.Layout (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use Layout
Package	Description
com.amazon.carbonado.layout	+ Support for recording the evolution of a storable's layout, used internally + by some repositories. +
com.amazon.carbonado.raw	+ Provides support for repositories that encode/decode storables in a raw + binary format. +

+ + +

Uses of Layout in com.amazon.carbonado.layout

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

Methods in com.amazon.carbonado.layout that return Layout
Modifier and Type	Method and Description
`Layout`	Layout.`getGeneration(int generation)` + Returns the layout for a particular generation of this layout's type. +
`Layout`	LayoutFactory.`layoutFor(boolean readOnly, + java.lang.Class<? extends Storable> type, + LayoutOptions options)` + Returns the layout matching the current definition of the given type. +
`Layout`	LayoutCapability.`layoutFor(java.lang.Class<? extends Storable> type)` + Returns the layout matching the current definition of the given type. +
`Layout`	LayoutFactory.`layoutFor(java.lang.Class<? extends Storable> type)` + Returns the layout matching the current definition of the given type. +
`Layout`	LayoutCapability.`layoutFor(java.lang.Class<? extends Storable> type, + int generation)` + Returns the layout for a particular generation of the given type. +
`Layout`	LayoutFactory.`layoutFor(java.lang.Class<? extends Storable> type, + int generation)` + Returns the layout for a particular generation of the given type. +
`Layout`	LayoutFactory.`layoutFor(java.lang.Class<? extends Storable> type, + LayoutOptions options)` + Returns the layout matching the current definition of the given type. +
`Layout`	Layout.`nextGeneration()` + Returns the next known generation of the storable's layout, or null + if none. +
`Layout`	Layout.`previousGeneration()` + Returns the previous known generation of the storable's layout, or null + if none. +
`Layout`	LayoutFactory.`readLayoutFrom(java.io.InputStream in)` + Read a layout as written by `writeTo(java.io.OutputStream)`. +

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

Methods in com.amazon.carbonado.layout with parameters of type Layout
Modifier and Type	Method and Description
`boolean`	Layout.`equalLayouts(Layout layout)` + Returns true if the given layout matches this one. +

+ + +

Uses of Layout in com.amazon.carbonado.raw

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

Methods in com.amazon.carbonado.raw with parameters of type Layout
Modifier and Type	Method and Description
`protected abstract <S extends Storable> CustomStorableCodec<S>`	CustomStorableCodecFactory.`createCodec(java.lang.Class<S> type, + boolean isMaster, + Layout layout)`
`protected <S extends Storable> CustomStorableCodec<S>`	CustomStorableCodecFactory.`createCodec(java.lang.Class<S> type, + boolean isMaster, + Layout layout, + RawSupport support)`
`<S extends Storable> CustomStorableCodec<S>`	CustomStorableCodecFactory.`createCodec(java.lang.Class<S> type, + StorableIndex pkIndex, + boolean isMaster, + Layout layout)`
`<S extends Storable> StorableCodec<S>`	StorableCodecFactory.`createCodec(java.lang.Class<S> type, + StorableIndex pkIndex, + boolean isMaster, + Layout layout)`
`<S extends Storable> GenericStorableCodec<S>`	GenericStorableCodecFactory.`createCodec(java.lang.Class<S> type, + StorableIndex pkIndex, + boolean isMaster, + Layout layout)`
`<S extends Storable> CustomStorableCodec<S>`	CustomStorableCodecFactory.`createCodec(java.lang.Class<S> type, + StorableIndex pkIndex, + boolean isMaster, + Layout layout, + RawSupport support)`
`<S extends Storable> StorableCodec<S>`	StorableCodecFactory.`createCodec(java.lang.Class<S> type, + StorableIndex pkIndex, + boolean isMaster, + Layout layout, + RawSupport support)`
`<S extends Storable> GenericStorableCodec<S>`	GenericStorableCodecFactory.`createCodec(java.lang.Class<S> type, + StorableIndex pkIndex, + boolean isMaster, + Layout layout, + RawSupport support)`

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html new file mode 100644 index 0000000..0ec261c --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutCapability.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.LayoutCapability (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use LayoutCapability
Package Description
com.amazon.carbonado.layout +
Support for recording the evolution of a storable's layout, used internally + by some repositories.
+
+
+
- + + +
  Uses of LayoutCapability in com.amazon.carbonado.layout
  + + + + + + + + + + + + +
  Classes in com.amazon.carbonado.layout that implement LayoutCapability
  Modifier and Type Class and Description
  class LayoutFactory +
  Factory for obtaining references to storable layouts.
  +
  +
+

Classes in com.amazon.carbonado.layout that implement LayoutCapability
Modifier and Type	Class and Description
`class`	`LayoutFactory` + Factory for obtaining references to storable layouts. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html new file mode 100644 index 0000000..ffc230f --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutFactory.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.LayoutFactory (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

No usage of com.amazon.carbonado.layout.LayoutFactory

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html new file mode 100644 index 0000000..0a48447 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutOptions.html @@ -0,0 +1,246 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.LayoutOptions (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use LayoutOptions
Package	Description
com.amazon.carbonado.layout	+ Support for recording the evolution of a storable's layout, used internally + by some repositories. +
com.amazon.carbonado.raw	+ Provides support for repositories that encode/decode storables in a raw + binary format. +

+ + +

Uses of LayoutOptions in com.amazon.carbonado.layout

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

Methods in com.amazon.carbonado.layout that return LayoutOptions
Modifier and Type	Method and Description
`LayoutOptions`	Layout.`getOptions()` + Returns additional options, or null if none. +

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

Methods in com.amazon.carbonado.layout with parameters of type LayoutOptions
Modifier and Type	Method and Description
`Layout`	LayoutFactory.`layoutFor(boolean readOnly, + java.lang.Class<? extends Storable> type, + LayoutOptions options)` + Returns the layout matching the current definition of the given type. +
`Layout`	LayoutFactory.`layoutFor(java.lang.Class<? extends Storable> type, + LayoutOptions options)` + Returns the layout matching the current definition of the given type. +

+ + +

Uses of LayoutOptions in com.amazon.carbonado.raw

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

Methods in com.amazon.carbonado.raw that return LayoutOptions
Modifier and Type	Method and Description
`LayoutOptions`	StorableCodecFactory.`getLayoutOptions(java.lang.Class<? extends Storable> type)` + Optionally return additional information regarding storable encoding. +
`LayoutOptions`	CompressedStorableCodecFactory.`getLayoutOptions(java.lang.Class<? extends Storable> type)`
`LayoutOptions`	GenericStorableCodecFactory.`getLayoutOptions(java.lang.Class<? extends Storable> type)` + Returns null. +

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

Methods in com.amazon.carbonado.raw with parameters of type LayoutOptions
Modifier and Type	Method and Description
`protected <S extends Storable> GenericEncodingStrategy<S>`	CompressedStorableCodecFactory.`createStrategy(java.lang.Class<S> type, + StorableIndex<S> pkIndex, + LayoutOptions options)`
`protected <S extends Storable> GenericEncodingStrategy<S>`	GenericStorableCodecFactory.`createStrategy(java.lang.Class<S> type, + StorableIndex<S> pkIndex, + LayoutOptions options)` + Override to return a different EncodingStrategy. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html new file mode 100644 index 0000000..c088c4b --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutProperty.html @@ -0,0 +1,169 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.LayoutProperty (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use LayoutProperty
Package Description
com.amazon.carbonado.layout +
Support for recording the evolution of a storable's layout, used internally + by some repositories.
+
+

+ + +

Uses of LayoutProperty in com.amazon.carbonado.layout

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

Methods in com.amazon.carbonado.layout that return types with arguments of type LayoutProperty
Modifier and Type	Method and Description
`java.util.List<LayoutProperty>`	Layout.`getAllProperties()` + Returns all the properties of this layout, in their proper order. +
`java.util.List<LayoutProperty>`	Layout.`getDataProperties()` + Returns all the non-primary key properties of this layout, in their + proper order. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html b/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html new file mode 100644 index 0000000..28ca812 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/LayoutSync.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class com.amazon.carbonado.layout.LayoutSync (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

No usage of com.amazon.carbonado.layout.LayoutSync

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html new file mode 100644 index 0000000..15fc3f1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayout.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.StoredLayout (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

No usage of com.amazon.carbonado.layout.StoredLayout

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html new file mode 100644 index 0000000..26c05dd --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutEquivalence.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.StoredLayoutEquivalence (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

No usage of com.amazon.carbonado.layout.StoredLayoutEquivalence

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html new file mode 100644 index 0000000..a344a31 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/StoredLayoutProperty.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.StoredLayoutProperty (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

No usage of com.amazon.carbonado.layout.StoredLayoutProperty

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html b/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html new file mode 100644 index 0000000..afa80a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/layout/class-use/Unevolvable.html @@ -0,0 +1,230 @@ + + + + + + +Uses of Interface com.amazon.carbonado.layout.Unevolvable (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use Unevolvable
Package	Description
com.amazon.carbonado.layout	+ Support for recording the evolution of a storable's layout, used internally + by some repositories. +
com.amazon.carbonado.repo.indexed	+ Repository implementation that adds index support for repositories that have + little or no index support. +
com.amazon.carbonado.repo.sleepycat	+ Repository implementation backed by a Sleepycat (BDB, Berkeley) + database. +

+ + +

Uses of Unevolvable in com.amazon.carbonado.layout

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

Subinterfaces of Unevolvable in com.amazon.carbonado.layout
Modifier and Type	Interface and Description
`interface`	`StoredLayout` + Stored information regarding the layout of a Storable type, which is used + internally by `Layout`. +
`interface`	`StoredLayoutEquivalence` + Maps layout generations which are equivalent. +
`interface`	`StoredLayoutProperty` + Stored property joined to a `StoredLayout`, which is used internally + by `LayoutProperty`. +