Uses of Class com.amazon.carbonado.info.ChainedProperty (Carbonado 1.2.3 API)

Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../carbonado/info/class-use/ChainedProperty.html | 385 +++++++++++++++ .../amazon/carbonado/info/class-use/Direction.html | 432 ++++++++++++++++ .../carbonado/info/class-use/OrderedProperty.html | 447 +++++++++++++++++ .../carbonado/info/class-use/StorableIndex.html | 544 +++++++++++++++++++++ .../carbonado/info/class-use/StorableInfo.html | 288 +++++++++++ .../info/class-use/StorableIntrospector.html | 163 ++++++ .../carbonado/info/class-use/StorableKey.html | 247 ++++++++++ .../carbonado/info/class-use/StorableProperty.html | 479 ++++++++++++++++++ .../info/class-use/StorablePropertyAdapter.html | 229 +++++++++ .../info/class-use/StorablePropertyAnnotation.html | 167 +++++++ .../info/class-use/StorablePropertyConstraint.html | 167 +++++++ 11 files changed, 3548 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/Direction.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/OrderedProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableIntrospector.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableKey.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html create mode 100644 apidocs/com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html (limited to 'apidocs/com/amazon/carbonado/info/class-use') diff --git a/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html b/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html new file mode 100644 index 0000000..5b8c49d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html @@ -0,0 +1,385 @@ + + + + + + +Uses of Class com.amazon.carbonado.info.ChainedProperty (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use ChainedProperty
Package	Description
com.amazon.carbonado.filter	+ Contains classes for representing query filters. +
com.amazon.carbonado.info	+ Introspection support for Storables. +
com.amazon.carbonado.qe	+ Support for implementing a Query Engine. +

+ + +

Uses of ChainedProperty in com.amazon.carbonado.filter

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

Methods in com.amazon.carbonado.filter that return ChainedProperty
Modifier and Type	Method and Description
`ChainedProperty<S>`	PropertyFilter.`getChainedProperty()`
`ChainedProperty<S>`	ExistsFilter.`getChainedProperty()` + Returns the join property that is being checked for existence or + non-existence. +

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

Methods in com.amazon.carbonado.filter with parameters of type ChainedProperty
Modifier and Type	Method and Description
`<T extends Storable> Filter<T>`	Filter.`asJoinedFrom(ChainedProperty<T> joinProperty)` + Prepends a join property to all properties of this filter. +
`<T extends Storable> PropertyFilter<T>`	PropertyFilter.`asJoinedFromAny(ChainedProperty<T> joinProperty)`
`<T extends Storable> Filter<T>`	OrFilter.`asJoinedFromAny(ChainedProperty<T> joinProperty)`
`<T extends Storable> ClosedFilter<T>`	ClosedFilter.`asJoinedFromAny(ChainedProperty<T> joinProperty)`
`<T extends Storable> Filter<T>`	AndFilter.`asJoinedFromAny(ChainedProperty<T> joinProperty)`
`abstract <T extends Storable> Filter<T>`	Filter.`asJoinedFromAny(ChainedProperty<T> joinProperty)` + Allows join from any property type, including one-to-many joins. +
`<T extends Storable> ExistsFilter<T>`	ExistsFilter.`asJoinedFromAny(ChainedProperty<T> joinProperty)`
`<T extends Storable> OpenFilter<T>`	OpenFilter.`asJoinedFromAny(ChainedProperty<T> joinProperty)`
`Filter.NotJoined`	Filter.`notJoinedFrom(ChainedProperty<S> joinProperty)` + Removes a join property prefix from all applicable properties of this + filter. +

+ + +

Uses of ChainedProperty in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return ChainedProperty
Modifier and Type	Method and Description
`ChainedProperty<S>`	ChainedProperty.`append(ChainedProperty<?> property)` + Returns a new ChainedProperty with another property appended. +
`ChainedProperty<S>`	ChainedProperty.`append(StorableProperty<?> property)` + Returns a new ChainedProperty with another property appended. +
`ChainedProperty<S>`	ChainedProperty.`append(StorableProperty<?> property, + boolean outerJoin)` + Returns a new ChainedProperty with another property appended. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`get(StorableProperty<S> prime)` + Returns a canonical instance which has no chain. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`get(StorableProperty<S> prime, + StorableProperty<?>... chain)` + Returns a canonical instance. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`get(StorableProperty<S> prime, + StorableProperty<?>[] chain, + boolean[] outerJoin)` + Returns a canonical instance. +
`ChainedProperty<S>`	OrderedProperty.`getChainedProperty()`
`ChainedProperty<S>[]`	StorableProperty.`getDerivedFromProperties()` + Returns a new array with all the derived-from properties, which is empty + if this is not a derived property. +
`ChainedProperty<?>[]`	StorableProperty.`getDerivedToProperties()` + Returns a new array with all the properties which are derived from this + one. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`parse(StorableInfo<S> info, + java.lang.String str)` + Parses a chained property. +
`ChainedProperty<?>`	ChainedProperty.`tail()` + Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property. +
`ChainedProperty<S>`	ChainedProperty.`trim()` + Returns a new ChainedProperty with the last property in the chain removed. +

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

Methods in com.amazon.carbonado.info with parameters of type ChainedProperty
Modifier and Type	Method and Description
`ChainedProperty<S>`	ChainedProperty.`append(ChainedProperty<?> property)` + Returns a new ChainedProperty with another property appended. +
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`get(ChainedProperty<S> property, + Direction direction)` + Returns a canonical instance. +

+ + +

Uses of ChainedProperty in com.amazon.carbonado.qe

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

Methods in com.amazon.carbonado.qe that return ChainedProperty
Modifier and Type	Method and Description
`ChainedProperty<S>`	IndexedQueryAnalyzer.Result.`getForeignProperty()` + Returns the simple or chained property that maps to the selected + foreign index. +

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

Methods in com.amazon.carbonado.qe with parameters of type ChainedProperty
Modifier and Type	Method and Description
`static <T extends Storable> QueryExecutor<T>`	JoinedQueryExecutor.`build(RepositoryAccess repoAccess, + ChainedProperty<T> targetToSourceProperty, + Filter<T> targetFilter, + OrderingList<T> targetOrdering, + QueryHints hints)` + Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/Direction.html b/apidocs/com/amazon/carbonado/info/class-use/Direction.html new file mode 100644 index 0000000..8e942f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/Direction.html @@ -0,0 +1,432 @@ + + + + + + +Uses of Class com.amazon.carbonado.info.Direction (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use Direction
Package	Description
com.amazon.carbonado.capability	+ Common capabilities for repositories. +
com.amazon.carbonado.info	+ Introspection support for Storables. +
com.amazon.carbonado.qe	+ Support for implementing a Query Engine. +
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. +

+ + +

Uses of Direction in com.amazon.carbonado.capability

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

Methods in com.amazon.carbonado.capability that return Direction
Modifier and Type	Method and Description
`Direction[]`	IndexInfo.`getPropertyDirections()` + Returns the directions of all the properties in this index. +

+ + +

Uses of Direction in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return Direction
Modifier and Type	Method and Description
`static Direction`	Direction.`fromCharacter(char c)` + Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else. +
`Direction`	OrderedProperty.`getDirection()`
`Direction`	StorableIndex.`getPropertyDirection(int index)` + Returns the requested direction of a specific property in this index. +
`Direction[]`	StorableIndex.`getPropertyDirections()` + Returns a new array with all the property directions in it. +
`Direction`	Direction.`reverse()` + Returns the reverse direction of this. +
`static Direction`	Direction.`valueOf(java.lang.String name)` + Returns the enum constant of this type with the specified name. +
`static Direction[]`	Direction.`values()` + Returns an array containing the constants of this enum type, in +the order they are declared. +

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

Methods in com.amazon.carbonado.info with parameters of type Direction
Modifier and Type	Method and Description
`StorableIndex<S>`	StorableIndex.`addProperty(StorableProperty<S> property, + Direction direction)` + Returns a StorableIndex with the given property added. +
`OrderedProperty<S>`	OrderedProperty.`direction(Direction direction)`
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`get(ChainedProperty<S> property, + Direction direction)` + Returns a canonical instance. +
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`get(StorableProperty<S> property, + Direction direction)` + Returns a canonical instance. +
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`parse(StorableInfo<S> info, + java.lang.String str, + Direction defaultDirection)` + Parses an ordering property, which may start with a '+' or '-' to + indicate direction. +
`StorableIndex<S>`	StorableIndex.`setDefaultDirection(Direction direction)` + Returns a StorableIndex instance with all unspecified directions set to + the given direction. +

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

Constructors in com.amazon.carbonado.info with parameters of type Direction
Constructor and Description
`StorableIndex(OrderedProperty<S>[] properties, + Direction direction)` + Creates a StorableIndex from OrderedProperties. +
`StorableIndex(StorableKey<S> key, + Direction direction)` + Creates a StorableIndex from a StorableKey. +
`StorableIndex(StorableProperty<S>[] properties, + Direction[] directions)` + Creates a StorableIndex from the given properties and matching + directions. +
`StorableIndex(StorableProperty<S>[] properties, + Direction[] directions, + boolean unique)` + Creates a StorableIndex from the given properties and matching + directions. +
`StorableIndex(StorableProperty<S>[] properties, + Direction[] directions, + boolean unique, + boolean clustered)` + Creates a StorableIndex from the given properties and matching + directions. +

+ + +

Uses of Direction in com.amazon.carbonado.qe

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

Methods in com.amazon.carbonado.qe with parameters of type Direction
Modifier and Type	Method and Description
`void`	StorableIndexSet.`addIndexes(StorableInfo<S> info, + Direction defaultDirection)` + Adds all the indexes of the given storable. +
`void`	StorableIndexSet.`reduce(Direction defaultDirection)` + Reduces the size of the set by removing redundant indexes, and merges + others together. +
`void`	StorableIndexSet.`setDefaultDirection(Direction defaultDirection)` + Set the default direction for all index properties. +

+ + +

Uses of Direction in com.amazon.carbonado.spi

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

Methods in com.amazon.carbonado.spi that return Direction
Modifier and Type	Method and Description
`Direction[]`	IndexInfoImpl.`getPropertyDirections()`

+ + + + + + + + + + +

Constructors in com.amazon.carbonado.spi with parameters of type Direction
Constructor and Description
`IndexInfoImpl(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + Direction[] propertyDirections)`

+ + +

Uses of Direction in com.amazon.carbonado.synthetic

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

Methods in com.amazon.carbonado.synthetic with parameters of type Direction
Modifier and Type	Method and Description
`SyntheticProperty`	SyntheticStorableReferenceBuilder.`addKeyProperty(java.lang.String name, + Direction direction)` + Add a property to the primary key which is a member of the Storable type + being referenced by this one. +
`void`	SyntheticPropertyList.`addProperty(java.lang.String propertyName, + Direction direction)` + Adds a property to this index, with the specified direction. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use OrderedProperty
Package	Description
com.amazon.carbonado.cursor	+ Support for advanced processing of cursor results, including basic set + theory operations. +
com.amazon.carbonado.info	+ Introspection support for Storables. +
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. +

+ + +

Uses of OrderedProperty in com.amazon.carbonado.cursor

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

Methods in com.amazon.carbonado.cursor with parameters of type OrderedProperty
Modifier and Type	Method and Description
`static <S extends Storable> java.util.Comparator<S>`	SortedCursor.`createComparator(OrderedProperty<S>... properties)` + Convenience method to create a comparator which orders storables by the + given properties. +

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

Method parameters in com.amazon.carbonado.cursor with type arguments of type OrderedProperty
Modifier and Type	Method and Description
`static <S extends Storable> java.util.Comparator<S>`	SortedCursor.`createComparator(java.util.List<OrderedProperty<S>> properties)` + Convenience method to create a comparator which orders storables by the + given properties. +

+ + +

Uses of OrderedProperty in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return OrderedProperty
Modifier and Type	Method and Description
`OrderedProperty<S>`	OrderedProperty.`direction(Direction direction)`
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`get(ChainedProperty<S> property, + Direction direction)` + Returns a canonical instance. +
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`get(StorableProperty<S> property, + Direction direction)` + Returns a canonical instance. +
`OrderedProperty<S>[]`	StorableIndex.`getOrderedProperties()` + Returns a new array with all the properties in it, with directions + folded in. +
`OrderedProperty<S>`	StorableIndex.`getOrderedProperty(int index)` + Returns a specific property in this index, with the direction folded in. +
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`parse(StorableInfo<S> info, + java.lang.String str)` + Parses an ordering property, which may start with a '+' or '-' to + indicate direction. +
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`parse(StorableInfo<S> info, + java.lang.String str, + Direction defaultDirection)` + Parses an ordering property, which may start with a '+' or '-' to + indicate direction. +
`OrderedProperty<S>`	OrderedProperty.`reverse()`

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

Methods in com.amazon.carbonado.info that return types with arguments of type OrderedProperty
Modifier and Type	Method and Description
`java.util.Set<? extends OrderedProperty<S>>`	StorableKey.`getProperties()` + Returns all the properties of the key in a properly ordered, + unmodifiable set. +

+ + + + + + + + + + +

Constructors in com.amazon.carbonado.info with parameters of type OrderedProperty
Constructor and Description
`StorableIndex(OrderedProperty<S>[] properties, + Direction direction)` + Creates a StorableIndex from OrderedProperties. +

+ + +

Uses of OrderedProperty in com.amazon.carbonado.qe

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

Methods in com.amazon.carbonado.qe that return OrderedProperty
Modifier and Type	Method and Description
`OrderedProperty<S>`	OrderingList.`get(int index)`

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

Methods in com.amazon.carbonado.qe with parameters of type OrderedProperty
Modifier and Type	Method and Description
`OrderingList<S>`	OrderingList.`concat(OrderedProperty<S> property)` + Returns a list which concatenates this one with the given property. +
`static <S extends Storable> FilteringScore<S>`	FilteringScore.`evaluate(OrderedProperty<S>[] indexProperties, + boolean unique, + boolean clustered, + Filter<S> filter)` + Evaluates the given index properties for its filtering capabilities + against the given filter. +
`static <S extends Storable> CompositeScore<S>`	CompositeScore.`evaluate(OrderedProperty<S>[] indexProperties, + boolean unique, + boolean clustered, + Filter<S> filter, + OrderingList<S> ordering)` + Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties. +
`static <S extends Storable> OrderingScore<S>`	OrderingScore.`evaluate(OrderedProperty<S>[] indexProperties, + boolean unique, + boolean clustered, + Filter<S> filter, + OrderingList<S> ordering)` + Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties. +
`static <S extends Storable> OrderingList<S>`	OrderingList.`get(OrderedProperty<S>... orderings)` + Returns a canonical instance composed of the given orderings. +
`OrderingList<S>`	OrderingList.`replace(int index, + OrderedProperty<S> property)` + Returns a list with the given element replaced. +

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

Method parameters in com.amazon.carbonado.qe with type arguments of type OrderedProperty
Modifier and Type	Method and Description
`static <S extends Storable> OrderingList<S>`	OrderingList.`get(java.util.List<OrderedProperty<S>> orderings)` + Returns a canonical instance composed of the given orderings. +

+ + +

Uses of OrderedProperty in com.amazon.carbonado.raw

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

Methods in com.amazon.carbonado.raw that return OrderedProperty
Modifier and Type	Method and Description
`protected OrderedProperty<S>[]`	GenericEncodingStrategy.`gatherAllKeyProperties()` + Returns all key properties as ordered properties, possibly with + unspecified directions. +

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

Methods in com.amazon.carbonado.raw with parameters of type OrderedProperty
Modifier and Type	Method and Description
`void`	GenericEncodingStrategy.`buildKeyDecoding(org.cojen.classfile.CodeAssembler assembler, + OrderedProperty<S>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + org.cojen.classfile.LocalVariable encodedVar)` + Generates bytecode instructions to decode properties. +
`org.cojen.classfile.LocalVariable`	GenericEncodingStrategy.`buildKeyEncoding(org.cojen.classfile.CodeAssembler assembler, + OrderedProperty<S>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + org.cojen.classfile.LocalVariable partialStartVar, + org.cojen.classfile.LocalVariable partialEndVar)` + Generates bytecode instructions to encode properties. +
`GenericStorableCodec.SearchKeyFactory<S>`	GenericStorableCodec.`getSearchKeyFactory(OrderedProperty<S>[] properties)` + Returns a search key factory, which is useful for implementing indexes + and queries. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html b/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html new file mode 100644 index 0000000..16c5fe8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html @@ -0,0 +1,544 @@ + + + + + + +Uses of Class com.amazon.carbonado.info.StorableIndex (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use StorableIndex
Package	Description
com.amazon.carbonado.info	+ Introspection support for Storables. +
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. +

+ + +

Uses of StorableIndex in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return StorableIndex
Modifier and Type	Method and Description
`StorableIndex<S>`	StorableIndex.`addProperty(StorableProperty<S> property, + Direction direction)` + Returns a StorableIndex with the given property added. +
`StorableIndex<S>`	StorableIndex.`clustered(boolean clustered)` + Returns a StorableIndex instance which is clustered or not. +
`StorableIndex<S>`	StorableInfo.`getIndex(int index)` + Returns a specific index for the Storable. +
`StorableIndex<S>[]`	StorableInfo.`getIndexes()` + Returns a new array with all the indexes in it. +
`static <S extends Storable> StorableIndex<S>`	StorableIndex.`parseNameDescriptor(java.lang.String desc, + StorableInfo<S> info)` + Parses an index descriptor and returns an index object. +
`StorableIndex<S>`	StorableIndex.`reverse()` + Returns a StorableIndex instance with all the properties reversed. +
`StorableIndex<S>`	StorableIndex.`setDefaultDirection(Direction direction)` + Returns a StorableIndex instance with all unspecified directions set to + the given direction. +
`StorableIndex<S>`	StorableIndex.`unique(boolean unique)` + Returns a StorableIndex instance which is unique or not. +
`StorableIndex<S>`	StorableIndex.`uniquify(StorableKey<S> key)` + Returns a StorableIndex which is unique, possibly by appending + properties from the given key. +

+ + +

Uses of StorableIndex in com.amazon.carbonado.qe

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

Methods in com.amazon.carbonado.qe that return StorableIndex
Modifier and Type	Method and Description
`StorableIndex<S>`	StorableIndexSet.`findKeyIndex(StorableKey<S> key)` + Finds the best index to represent the given key. +
`StorableIndex<S>`	StorableIndexSet.`findPrimaryKeyIndex(StorableInfo<S> info)` + Finds the best index to represent the primary key. +
`StorableIndex<?>`	IndexedQueryAnalyzer.Result.`getForeignIndex()` + Returns the foreign index that was selected, or null if a local + index was selected. +
`StorableIndex<S>`	IndexedQueryAnalyzer.Result.`getLocalIndex()` + Returns the local index that was selected, or null if a foreign + index was selected. +

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

Methods in com.amazon.carbonado.qe that return types with arguments of type StorableIndex
Modifier and Type	Method and Description
`java.util.Collection<StorableIndex<S>>`	StorageAccess.`getAllIndexes()` + Returns all the available indexes. +

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

Methods in com.amazon.carbonado.qe with parameters of type StorableIndex
Modifier and Type	Method and Description
`static <S extends Storable> FilteringScore<S>`	FilteringScore.`evaluate(StorableIndex<S> index, + Filter<S> filter)` + Evaluates the given index for its filtering capabilities against the + given filter. +
`static <S extends Storable> CompositeScore<S>`	CompositeScore.`evaluate(StorableIndex<S> index, + Filter<S> filter, + OrderingList<S> ordering)` + Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties. +
`static <S extends Storable> OrderingScore<S>`	OrderingScore.`evaluate(StorableIndex<S> index, + Filter<S> filter, + OrderingList<S> ordering)` + Evaluates the given index for its ordering capabilities against the + given filter and order-by properties. +
`Cursor<S>`	IndexedQueryExecutor.Support.`fetchFromIndexEntryQuery(StorableIndex<S> index, + Query<?> indexEntryQuery)` + Fetch Storables referenced by the given index entry query. +
`Cursor<S>`	IndexedQueryExecutor.Support.`fetchFromIndexEntryQuery(StorableIndex<S> index, + Query<?> indexEntryQuery, + Query.Controller controller)` + Fetch Storables referenced by the given index entry query. +
`Cursor<S>`	KeyQueryExecutor.Support.`fetchOne(StorableIndex<S> index, + java.lang.Object[] identityValues)` + Select at most one Storable referenced by an index. +
`Cursor<S>`	KeyQueryExecutor.Support.`fetchOne(StorableIndex<S> index, + java.lang.Object[] identityValues, + Query.Controller controller)` + Select at most one Storable referenced by an index. +
`Cursor<S>`	IndexedQueryExecutor.Support.`fetchSubset(StorableIndex<S> index, + java.lang.Object[] identityValues, + BoundaryType rangeStartBoundary, + java.lang.Object rangeStartValue, + BoundaryType rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)` + Perform an index scan of a subset of Storables referenced by an + index. +
`Cursor<S>`	IndexedQueryExecutor.Support.`fetchSubset(StorableIndex<S> index, + java.lang.Object[] identityValues, + BoundaryType rangeStartBoundary, + java.lang.Object rangeStartValue, + BoundaryType rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + Query.Controller controller)` + Perform an index scan of a subset of Storables referenced by an + index. +
`Query<?>`	IndexedQueryExecutor.Support.`indexEntryQuery(StorableIndex<S> index)` + Returns an open query if the given index supports query access. +
`Storage<S>`	StorageAccess.`storageDelegate(StorableIndex<S> index)` + If the given index is not directly supported by storage, queries should + be delegated. +

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

Constructors in com.amazon.carbonado.qe with parameters of type StorableIndex
Constructor and Description
`IndexedQueryExecutor(IndexedQueryExecutor.Support<S> support, + StorableIndex<S> index, + CompositeScore<S> score)`
`KeyQueryExecutor(KeyQueryExecutor.Support<S> support, + StorableIndex<S> index, + FilteringScore<S> score)`

+ + +

Uses of StorableIndex in com.amazon.carbonado.raw

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

Methods in com.amazon.carbonado.raw that return StorableIndex
Modifier and Type	Method and Description
`StorableIndex<S>`	CustomStorableCodec.`buildPkIndex(java.lang.String... propertyNames)` + Convenient way to define the clustered primary key index + descriptor. +
`StorableIndex<S>`	StorableCodec.`getPrimaryKeyIndex()` + Returns the sequence and directions of properties that make up the + primary key. +
`protected StorableIndex<S>`	GenericEncodingStrategy.`getPrimaryKeyIndex()` + Returns all key properties in the form of an index. +
`StorableIndex<S>`	GenericStorableCodec.`getPrimaryKeyIndex()`

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

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

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

Constructors in com.amazon.carbonado.raw with parameters of type StorableIndex
Constructor and Description
`CompressedEncodingStrategy(java.lang.Class<S> type, + StorableIndex<S> pkIndex, + CompressionType compressionType)`
`GenericEncodingStrategy(java.lang.Class<S> type, + StorableIndex<S> pkIndex)`
`GenericEncodingStrategy(java.lang.Class<S> type, + StorableIndex<S> pkIndex, + int keyPrefixPadding, + int keySuffixPadding, + int dataPrefixPadding, + int dataSuffixPadding)`

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use StorableInfo
Package	Description
com.amazon.carbonado.info	+ Introspection support for Storables. +
com.amazon.carbonado.qe	+ Support for implementing a Query Engine. +
com.amazon.carbonado.repo.jdbc	+ Repository implementation that connects to an external SQL database via + JDBC. +

+ + +

Uses of StorableInfo in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return StorableInfo
Modifier and Type	Method and Description
`static <S extends Storable> StorableInfo<S>`	StorableIntrospector.`examine(java.lang.Class<S> type)` + Examines the given class and returns a StorableInfo describing it. +

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

Methods in com.amazon.carbonado.info with parameters of type StorableInfo
Modifier and Type	Method and Description
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`parse(StorableInfo<S> info, + java.lang.String str)` + Parses an ordering property, which may start with a '+' or '-' to + indicate direction. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`parse(StorableInfo<S> info, + java.lang.String str)` + Parses a chained property. +
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`parse(StorableInfo<S> info, + java.lang.String str, + Direction defaultDirection)` + Parses an ordering property, which may start with a '+' or '-' to + indicate direction. +
`static <S extends Storable> StorableIndex<S>`	StorableIndex.`parseNameDescriptor(java.lang.String desc, + StorableInfo<S> info)` + Parses an index descriptor and returns an index object. +

+ + +

Uses of StorableInfo in com.amazon.carbonado.qe

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

Methods in com.amazon.carbonado.qe with parameters of type StorableInfo
Modifier and Type	Method and Description
`void`	StorableIndexSet.`addAlternateKeys(StorableInfo<S> info)` + Adds all of the alternate keys of the given storable as indexes by + calling `addKey`. +
`void`	StorableIndexSet.`addIndexes(StorableInfo<S> info)` + Adds all the indexes of the given storable. +
`void`	StorableIndexSet.`addIndexes(StorableInfo<S> info, + Direction defaultDirection)` + Adds all the indexes of the given storable. +
`void`	StorableIndexSet.`addPrimaryKey(StorableInfo<S> info)` + Adds the primary key of the given storable as indexes by calling `addKey`. +
`StorableIndex<S>`	StorableIndexSet.`findPrimaryKeyIndex(StorableInfo<S> info)` + Finds the best index to represent the primary key. +
`void`	StorableIndexSet.`uniquify(StorableInfo<S> info)` + Augment non-unique indexes with primary key properties, thus making them + unique. +

+ + +

Uses of StorableInfo in com.amazon.carbonado.repo.jdbc

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

Subinterfaces of StorableInfo in com.amazon.carbonado.repo.jdbc
Modifier and Type	Interface and Description
`interface`	`JDBCStorableInfo<S extends Storable>` + Contains all the metadata describing a specific `Storable` type as + needed by JDBCRepository. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use StorableIntrospector
Package Description
com.amazon.carbonado.repo.jdbc +
Repository implementation that connects to an external SQL database via + JDBC.
+
+

Packages that use StorableIntrospector
Package	Description
com.amazon.carbonado.repo.jdbc	+ Repository implementation that connects to an external SQL database via + JDBC. +

+ + +

Uses of StorableIntrospector in com.amazon.carbonado.repo.jdbc

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

Subclasses of StorableIntrospector in com.amazon.carbonado.repo.jdbc
Modifier and Type	Class and Description
`class`	`JDBCStorableIntrospector` + Provides additional metadata for a `Storable` type needed by + JDBCRepository. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html new file mode 100644 index 0000000..377457c --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html @@ -0,0 +1,247 @@ + + + + + + +Uses of Interface com.amazon.carbonado.info.StorableKey (Carbonado 1.2.3 API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + + + + + +
Packages that use StorableKey
Package Description
com.amazon.carbonado.info +
Introspection support for Storables.
+
com.amazon.carbonado.qe +
Support for implementing a Query Engine.
+
+

+ + +

Uses of StorableKey in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return StorableKey
Modifier and Type	Method and Description
`StorableKey<S>`	StorableInfo.`getAlternateKey(int index)` + Returns a specific alternate key for the Storable. +
`StorableKey<S>[]`	StorableInfo.`getAlternateKeys()` + Returns a new array with all the alternate keys in it. +
`StorableKey<S>`	StorableInfo.`getPartitionKey()` + Returns the partition key for the Storable, or null if none exists. +
`StorableKey<S>`	StorableInfo.`getPrimaryKey()` + Returns the primary key for the Storable, never null. +

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

Methods in com.amazon.carbonado.info with parameters of type StorableKey
Modifier and Type	Method and Description
`StorableIndex<S>`	StorableIndex.`uniquify(StorableKey<S> key)` + Returns a StorableIndex which is unique, possibly by appending + properties from the given key. +

+ + + + + + + + + + +

Constructors in com.amazon.carbonado.info with parameters of type StorableKey
Constructor and Description
`StorableIndex(StorableKey<S> key, + Direction direction)` + Creates a StorableIndex from a StorableKey. +

+ + +

Uses of StorableKey in com.amazon.carbonado.qe

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

Methods in com.amazon.carbonado.qe with parameters of type StorableKey
Modifier and Type	Method and Description
`void`	StorableIndexSet.`addKey(StorableKey<S> key)` + Adds the key as a unique index, preserving the property arrangement. +
`StorableIndex<S>`	StorableIndexSet.`findKeyIndex(StorableKey<S> key)` + Finds the best index to represent the given key. +
`void`	StorableIndexSet.`uniquify(StorableKey<S> key)` + Augment non-unique indexes with key properties, thus making them unique. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use StorableProperty
Package	Description
com.amazon.carbonado.info	+ Introspection support for Storables. +
com.amazon.carbonado.raw	+ Provides support for repositories that encode/decode storables in a raw + binary format. +
com.amazon.carbonado.repo.jdbc	+ Repository implementation that connects to an external SQL database via + JDBC. +

+ + +

Uses of StorableProperty in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return StorableProperty
Modifier and Type	Method and Description
`StorableProperty<?>`	ChainedProperty.`getChainedProperty(int index)`
`StorableProperty<?>`	StorableProperty.`getExternalJoinElement(int index)` + Returns a specific property in the joined class that participates in the + join. +
`StorableProperty<?>[]`	StorableProperty.`getExternalJoinElements()` + Returns a new array with all the external join elements in it. +
`StorableProperty<S>`	StorableProperty.`getInternalJoinElement(int index)` + Returns a specific property in this property's class that participates + in the join. +
`StorableProperty<S>[]`	StorableProperty.`getInternalJoinElements()` + Returns a new array with all the internal join elements in it. +
`StorableProperty<?>`	ChainedProperty.`getLastProperty()` + Returns the last property in the chain, or the prime property if chain + is empty. +
`StorableProperty<S>`	ChainedProperty.`getPrimeProperty()`
`StorableProperty<S>[]`	StorableIndex.`getProperties()` + Returns a new array with all the properties in it. +
`StorableProperty<S>`	StorableIndex.`getProperty(int index)` + Returns a specific property in this index. +
`StorableProperty<S>`	StorableInfo.`getVersionProperty()` + Returns the designated version property, or null if none. +

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

Methods in com.amazon.carbonado.info that return types with arguments of type StorableProperty
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,? extends StorableProperty<S>>`	StorableInfo.`getAllProperties()` + Returns all the storable properties in an unmodifiable map. +
`java.util.Map<java.lang.String,? extends StorableProperty<S>>`	StorableInfo.`getDataProperties()` + Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. +
`java.util.Map<java.lang.String,? extends StorableProperty<S>>`	StorableInfo.`getPrimaryKeyProperties()` + Returns a subset of the storable properties in an unmodifiable map + that define the primary key. +

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

Methods in com.amazon.carbonado.info with parameters of type StorableProperty
Modifier and Type	Method and Description
`StorableIndex<S>`	StorableIndex.`addProperty(StorableProperty<S> property, + Direction direction)` + Returns a StorableIndex with the given property added. +
`ChainedProperty<S>`	ChainedProperty.`append(StorableProperty<?> property)` + Returns a new ChainedProperty with another property appended. +
`ChainedProperty<S>`	ChainedProperty.`append(StorableProperty<?> property, + boolean outerJoin)` + Returns a new ChainedProperty with another property appended. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`get(StorableProperty<S> prime)` + Returns a canonical instance which has no chain. +
`static <S extends Storable> OrderedProperty<S>`	OrderedProperty.`get(StorableProperty<S> property, + Direction direction)` + Returns a canonical instance. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`get(StorableProperty<S> prime, + StorableProperty<?>... chain)` + Returns a canonical instance. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`get(StorableProperty<S> prime, + StorableProperty<?>... chain)` + Returns a canonical instance. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`get(StorableProperty<S> prime, + StorableProperty<?>[] chain, + boolean[] outerJoin)` + Returns a canonical instance. +
`static <S extends Storable> ChainedProperty<S>`	ChainedProperty.`get(StorableProperty<S> prime, + StorableProperty<?>[] chain, + boolean[] outerJoin)` + Returns a canonical instance. +

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

Constructors in com.amazon.carbonado.info with parameters of type StorableProperty
Constructor and Description
`StorableIndex(StorableProperty<S>[] properties, + Direction[] directions)` + Creates a StorableIndex from the given properties and matching + directions. +
`StorableIndex(StorableProperty<S>[] properties, + Direction[] directions, + boolean unique)` + Creates a StorableIndex from the given properties and matching + directions. +
`StorableIndex(StorableProperty<S>[] properties, + Direction[] directions, + boolean unique, + boolean clustered)` + Creates a StorableIndex from the given properties and matching + directions. +

+ + +

Uses of StorableProperty in com.amazon.carbonado.raw

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

Methods in com.amazon.carbonado.raw that return StorableProperty
Modifier and Type	Method and Description
`protected StorableProperty<S>[]`	GenericEncodingStrategy.`gatherAllDataProperties()` + Returns all non-derived data properties for storable. +
`protected StorableProperty<S>[]`	GenericEncodingStrategy.`gatherAllProperties()` + Returns all non-join, non-derived properties for storable. +

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

Methods in com.amazon.carbonado.raw that return types with arguments of type StorableProperty
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,? extends StorableProperty<S>>`	CustomStorableCodec.`getAllProperties()` + Convenient access to all the storable properties. +

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

Methods in com.amazon.carbonado.raw with parameters of type StorableProperty
Modifier and Type	Method and Description
`void`	GenericEncodingStrategy.`buildDataDecoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + int generation, + org.cojen.classfile.Label altGenerationHandler, + org.cojen.classfile.LocalVariable encodedVar)` + Generates bytecode instructions to decode properties. +
`org.cojen.classfile.LocalVariable`	GenericEncodingStrategy.`buildDataEncoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + int generation)` + Generates bytecode instructions to encode properties. +
`void`	GenericEncodingStrategy.`buildSerialDecoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties, + org.cojen.classfile.LocalVariable encodedVar)` + Generates bytecode instructions to decode properties and their states. +
`org.cojen.classfile.LocalVariable`	GenericEncodingStrategy.`buildSerialEncoding(org.cojen.classfile.CodeAssembler assembler, + StorableProperty<S>[] properties)` + Generates bytecode instructions to encode properties and their + states. +
`protected StorablePropertyInfo`	GenericEncodingStrategy.`checkSupport(StorableProperty<S> property)`
`protected StorablePropertyInfo[]`	GenericEncodingStrategy.`checkSupport(StorableProperty<S>[] properties)`

+ + +

Uses of StorableProperty in com.amazon.carbonado.repo.jdbc

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

Subinterfaces of StorableProperty in com.amazon.carbonado.repo.jdbc
Modifier and Type	Interface and Description
`interface`	`JDBCStorableProperty<S extends Storable>` + Contains all the metadata describing a property of a specific `Storable` type as needed by JDBCRepository. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

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

Packages that use StorablePropertyAdapter
Package	Description
com.amazon.carbonado.info	+ Introspection support for Storables. +
com.amazon.carbonado.repo.jdbc	+ Repository implementation that connects to an external SQL database via + JDBC. +
com.amazon.carbonado.synthetic	+ Support for dynamic creation of storables, intended for internal use by + repository implementations. +

+ + +

Uses of StorablePropertyAdapter in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return StorablePropertyAdapter
Modifier and Type	Method and Description
`StorablePropertyAdapter`	StorableProperty.`getAdapter()` + Returns this property's adapter, or null if none. +

+ + +

Uses of StorablePropertyAdapter in com.amazon.carbonado.repo.jdbc

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

Methods in com.amazon.carbonado.repo.jdbc that return StorablePropertyAdapter
Modifier and Type	Method and Description
`StorablePropertyAdapter`	JDBCStorableProperty.`getAppliedAdapter()` + Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements. +

+ + +

Uses of StorablePropertyAdapter in com.amazon.carbonado.synthetic

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

Methods in com.amazon.carbonado.synthetic that return StorablePropertyAdapter
Modifier and Type	Method and Description
`StorablePropertyAdapter`	SyntheticProperty.`getAdapter()`

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

Methods in com.amazon.carbonado.synthetic with parameters of type StorablePropertyAdapter
Modifier and Type	Method and Description
`void`	SyntheticProperty.`setAdapter(StorablePropertyAdapter adapter)` + Storables cannot currently have more than one adapter per property. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use StorablePropertyAnnotation
Package Description
com.amazon.carbonado.info +
Introspection support for Storables.
+
+

+ + +

Uses of StorablePropertyAnnotation in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return StorablePropertyAnnotation
Modifier and Type	Method and Description
`StorablePropertyAnnotation`	StorablePropertyAdapter.`getAnnotation()` + Returns the annotation that applied this adapter, or null if none. +
`StorablePropertyAnnotation`	StorablePropertyConstraint.`getAnnotation()` + Returns the annotation that applied this constraint. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

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

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + +
Packages that use StorablePropertyConstraint
Package Description
com.amazon.carbonado.info +
Introspection support for Storables.
+
+

+ + +

Uses of StorablePropertyConstraint in com.amazon.carbonado.info

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

Methods in com.amazon.carbonado.info that return StorablePropertyConstraint
Modifier and Type	Method and Description
`StorablePropertyConstraint`	StorableProperty.`getConstraint(int index)` + Returns a specific constraint for this property. +
`StorablePropertyConstraint[]`	StorableProperty.`getConstraints()` + Returns a new array with all the constraints in it. +

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ +

+ + -- cgit v1.2.3